Location - List Supported Cloud Service Skus

Gets the list of Batch supported Cloud Service VM sizes available at the given location.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/cloudServiceSkus?api-version=2022-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/cloudServiceSkus?maxresults={maxresults}&$filter={$filter}&api-version=2022-01-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

The operation was successful. The response contains the Batch service supported Cloud Service VM sizes for the subscription in the specified location.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

LocationListCloudServiceSkus

Sample Request

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

Sample Response

{
  "value": [
    {
      "name": "Small",
      "familyName": "standardA0_A7Family",
      "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"
        }
      ]
    }
  ]
}

Definitions

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

An error response from the Batch service.

Name Type Description
error

The body of the error response.

CloudErrorBody

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

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

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

Describes a Batch supported SKU.

Name Type Description
capabilities

A collection of capabilities which this SKU supports.

familyName
  • string

The family name of the SKU.

name
  • string

The name of the SKU.

SupportedSkusResult

The Batch List supported SKUs operation response.

Name Type Description
nextLink
  • string

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

value

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