azure.ai.ml.entities.VmSize.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.VmSize
name: VmSize
fullName: azure.ai.ml.entities.VmSize
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: Virtual Machine Size.
constructor:
  syntax: 'VmSize(name: str | None = None, family: str | None = None, v_cp_us: int
    | None = None, gpus: int | None = None, os_vhd_size_mb: int | None = None, max_resource_volume_mb:
    int | None = None, memory_gb: float | None = None, low_priority_capable: bool
    | None = None, premium_io: bool | None = None, supported_compute_types: List[str]
    | None = None)'
  parameters:
  - name: name
    description: The virtual machine size name.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: family
    description: The virtual machine size family name.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: v_cp_us
    description: The number of vCPUs supported by the virtual machine size.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: gpus
    description: The number of GPUs supported by the virtual machine size.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: os_vhd_size_mb
    description: The OS VHD disk size, in MB, allowed by the virtual machine size.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: max_resource_volume_mb
    description: 'The resource volume size, in MB, allowed by the virtual machine

      size.'
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: memory_gb
    description: The amount of memory, in GB, supported by the virtual machine size.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:float>]
  - name: low_priority_capable
    description: Specifies if the virtual machine size supports low priority VMs.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:bool>]
  - name: premium_io
    description: Specifies if the virtual machine size supports premium IO.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:bool>]
  - name: estimated_vm_prices
    description: The estimated price information for using a VM.
    isRequired: true
    types:
    - <xref:azure.mgmt.machinelearningservices.models.EstimatedVMPrices>
  - name: supported_compute_types
    description: 'Specifies the compute types supported by the virtual machine

      size.'
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:list>[<xref:str>]]
methods:
- uid: azure.ai.ml.entities.VmSize.dump
  name: dump
  summary: Dump the virtual machine size content into a file in yaml format.
  signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
  parameters:
  - name: dest
    description: 'The destination to receive this virtual machine size''s content.

      Must be either a path to a local file, or an already-open file stream.

      If dest is a file path, a new file will be created,

      and an exception is raised if the file exists.

      If dest is an open file, the file will be written to directly,

      and an exception will be raised if the file is not writable.'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]