Compartilhar via

Location - List Supported Virtual Machine Skus

  • Reference
Service:
Batch Management
API Version:
2024-07-01

Gets the list of Batch supported Virtual Machine VM sizes available at the given location.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus?api-version=2024-07-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus?maxresults={maxresults}&$filter={$filter}&api-version=2024-07-01

URI Parameters

Name In Required Type Description
locationName
 path True

string

The region for which to retrieve Batch service supported SKUs.
subscriptionId
 path True

string

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
api-version
 query True

string

The API version to be used with the HTTP request.
$filter
 query

string

OData filter expression. Valid properties for filtering are "familyName".
maxresults
 query

integer

int32

The maximum number of items to return in the response.

Responses

Name Type Description
200 OK

SupportedSkusResult

The operation was successful. The response contains the Batch service supported virtual machine vm sizes for the subscription in the specified location.
Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

LocationListVirtualMachineSkus

Sample request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Batch/locations/japaneast/virtualMachineSkus?api-version=2024-07-01

Sample response

Status code:
200 
{
  "value": [
    {
      "name": "Standard_D1_v2",
      "familyName": "standardDFamily",
      "capabilities": [
        {
          "name": "MaxResourceVolumeMB",
          "value": "20480"
        },
        {
          "name": "vCPUs",
          "value": "1"
        },
        {
          "name": "HyperVGenerations",
          "value": "V1"
        },
        {
          "name": "MemoryGB",
          "value": "0.75"
        },
        {
          "name": "LowPriorityCapable",
          "value": "False"
        },
        {
          "name": "vCPUsAvailable",
          "value": "1"
        },
        {
          "name": "EphemeralOSDiskSupported",
          "value": "False"
        }
      ]
    },
    {
      "name": "Standard_A1",
      "familyName": "standardA0_A7Family",
      "capabilities": [
        {
          "name": "MaxResourceVolumeMB",
          "value": "71680"
        },
        {
          "name": "OSVhdSizeMB",
          "value": "1047552"
        },
        {
          "name": "vCPUs",
          "value": "1"
        },
        {
          "name": "MemoryPreservingMaintenanceSupported",
          "value": "True"
        },
        {
          "name": "HyperVGenerations",
          "value": "V1"
        },
        {
          "name": "MemoryGB",
          "value": "1.75"
        },
        {
          "name": "MaxDataDiskCount",
          "value": "2"
        },
        {
          "name": "CpuArchitectureType",
          "value": "x64"
        },
        {
          "name": "LowPriorityCapable",
          "value": "False"
        },
        {
          "name": "PremiumIO",
          "value": "False"
        },
        {
          "name": "VMDeploymentTypes",
          "value": "IaaS,PaaS"
        },
        {
          "name": "vCPUsAvailable",
          "value": "1"
        },
        {
          "name": "ACUs",
          "value": "100"
        },
        {
          "name": "vCPUsPerCore",
          "value": "1"
        },
        {
          "name": "EphemeralOSDiskSupported",
          "value": "False"
        },
        {
          "name": "EncryptionAtHostSupported",
          "value": "False"
        },
        {
          "name": "CapacityReservationSupported",
          "value": "False"
        },
        {
          "name": "AcceleratedNetworkingEnabled",
          "value": "False"
        },
        {
          "name": "RdmaEnabled",
          "value": "False"
        },
        {
          "name": "MaxNetworkInterfaces",
          "value": "2"
        }
      ],
      "batchSupportEndOfLife": "2024-08-31T00:00:00Z"
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the Batch service.
CloudErrorBody

An error response from the Batch service.
SkuCapability

A SKU capability, such as the number of cores.
SupportedSku

Describes a Batch supported SKU.
SupportedSkusResult

The Batch List supported SKUs operation response.

CloudError

Object

An error response from the Batch service.

Name Type Description
error

CloudErrorBody

The body of the error response.

CloudErrorBody

Object

An error response from the Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

A message describing the error, intended to be suitable for display in a user interface.
target

string

The target of the particular error. For example, the name of the property in error.

SkuCapability

Object

A SKU capability, such as the number of cores.

Name Type Description
name

string

The name of the feature.
value

string

The value of the feature.

SupportedSku

Object

Describes a Batch supported SKU.

Name Type Description
batchSupportEndOfLife

string

The time when Azure Batch service will retire this SKU.
capabilities

SkuCapability[]

A collection of capabilities which this SKU supports.
familyName

string

The family name of the SKU.
name

string

The name of the SKU.

SupportedSkusResult

Object

The Batch List supported SKUs operation response.

Name Type Description
nextLink

string

The URL to use for getting the next set of results.
value

SupportedSku[]

The list of SKUs available for the Batch service in the location.