Location - List Supported Virtual Machine Skus

Usługa:: Batch Management

Wersja API:: 2024-07-01

Pobiera listę rozmiarów maszyn wirtualnych obsługiwanych przez usługę Batch dostępnych w danej lokalizacji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus?api-version=2024-07-01

Z opcjonalnymi parametrami:

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
locationName	path	True	string	Region, dla którego mają być pobierane obsługiwane jednostki SKU usługi Batch.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Wyrażenie filtru OData. Prawidłowe właściwości filtrowania to "familyName".
maxresults	query		integer (int32)	Maksymalna liczba elementów do zwrócenia w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SupportedSkusResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

LocationListVirtualMachineSkus

Przykładowa prośba

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


/**
 * Samples for Location ListSupportedVirtualMachineSkus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/LocationListVirtualMachineSkus.
     * json
     */
    /**
     * Sample code: LocationListVirtualMachineSkus.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void locationListVirtualMachineSkus(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.locations().listSupportedVirtualMachineSkus("japaneast", null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python location_list_virtual_machine_skus.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.location.list_supported_virtual_machine_skus(
        location_name="japaneast",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/LocationListVirtualMachineSkus.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/LocationListVirtualMachineSkus.json
func ExampleLocationClient_NewListSupportedVirtualMachineSKUsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLocationClient().NewListSupportedVirtualMachineSKUsPager("japaneast", &armbatch.LocationClientListSupportedVirtualMachineSKUsOptions{Maxresults: nil,
		Filter: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SupportedSKUsResult = armbatch.SupportedSKUsResult{
		// 	Value: []*armbatch.SupportedSKU{
		// 		{
		// 			Name: to.Ptr("Standard_D1_v2"),
		// 			Capabilities: []*armbatch.SKUCapability{
		// 				{
		// 					Name: to.Ptr("MaxResourceVolumeMB"),
		// 					Value: to.Ptr("20480"),
		// 				},
		// 				{
		// 					Name: to.Ptr("vCPUs"),
		// 					Value: to.Ptr("1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("HyperVGenerations"),
		// 					Value: to.Ptr("V1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("MemoryGB"),
		// 					Value: to.Ptr("0.75"),
		// 				},
		// 				{
		// 					Name: to.Ptr("LowPriorityCapable"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("vCPUsAvailable"),
		// 					Value: to.Ptr("1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("EphemeralOSDiskSupported"),
		// 					Value: to.Ptr("False"),
		// 			}},
		// 			FamilyName: to.Ptr("standardDFamily"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Standard_A1"),
		// 			BatchSupportEndOfLife: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-08-31T00:00:00.000Z"); return t}()),
		// 			Capabilities: []*armbatch.SKUCapability{
		// 				{
		// 					Name: to.Ptr("MaxResourceVolumeMB"),
		// 					Value: to.Ptr("71680"),
		// 				},
		// 				{
		// 					Name: to.Ptr("OSVhdSizeMB"),
		// 					Value: to.Ptr("1047552"),
		// 				},
		// 				{
		// 					Name: to.Ptr("vCPUs"),
		// 					Value: to.Ptr("1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("MemoryPreservingMaintenanceSupported"),
		// 					Value: to.Ptr("True"),
		// 				},
		// 				{
		// 					Name: to.Ptr("HyperVGenerations"),
		// 					Value: to.Ptr("V1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("MemoryGB"),
		// 					Value: to.Ptr("1.75"),
		// 				},
		// 				{
		// 					Name: to.Ptr("MaxDataDiskCount"),
		// 					Value: to.Ptr("2"),
		// 				},
		// 				{
		// 					Name: to.Ptr("CpuArchitectureType"),
		// 					Value: to.Ptr("x64"),
		// 				},
		// 				{
		// 					Name: to.Ptr("LowPriorityCapable"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("PremiumIO"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("VMDeploymentTypes"),
		// 					Value: to.Ptr("IaaS,PaaS"),
		// 				},
		// 				{
		// 					Name: to.Ptr("vCPUsAvailable"),
		// 					Value: to.Ptr("1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("ACUs"),
		// 					Value: to.Ptr("100"),
		// 				},
		// 				{
		// 					Name: to.Ptr("vCPUsPerCore"),
		// 					Value: to.Ptr("1"),
		// 				},
		// 				{
		// 					Name: to.Ptr("EphemeralOSDiskSupported"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("EncryptionAtHostSupported"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("CapacityReservationSupported"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("AcceleratedNetworkingEnabled"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("RdmaEnabled"),
		// 					Value: to.Ptr("False"),
		// 				},
		// 				{
		// 					Name: to.Ptr("MaxNetworkInterfaces"),
		// 					Value: to.Ptr("2"),
		// 			}},
		// 			FamilyName: to.Ptr("standardA0_A7Family"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the list of Batch supported Virtual Machine VM sizes available at the given location.
 *
 * @summary Gets the list of Batch supported Virtual Machine VM sizes available at the given location.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/LocationListVirtualMachineSkus.json
 */
async function locationListVirtualMachineSkus() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const locationName = "japaneast";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.location.listSupportedVirtualMachineSkus(locationName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/LocationListVirtualMachineSkus.json
// this example is just showing the usage of "Location_ListSupportedVirtualMachineSkus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation locationName = new AzureLocation("japaneast");
await foreach (BatchSupportedSku item in subscriptionResource.GetBatchSupportedVirtualMachineSkusAsync(locationName))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod statusu:: 200

{
  "value": [
    {
      "name": "Standard_D1_v2",
      "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"
        }
      ],
      "familyName": "standardDFamily"
    },
    {
      "name": "Standard_A1",
      "batchSupportEndOfLife": "2024-08-31T00:00:00Z",
      "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"
        }
      ],
      "familyName": "standardA0_A7Family"
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Batch.
CloudErrorBody	Odpowiedź na błąd z usługi Batch.
SkuCapability	Możliwość jednostki SKU, taka jak liczba rdzeni.
SupportedSku	Opisuje obsługiwaną jednostkę SKU usługi Batch.
SupportedSkusResult	Odpowiedź operacji jednostki SKU obsługiwana przez listę usługi Batch.

CloudError

Sprzeciwiać się

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść odpowiedzi o błędzie.

CloudErrorBody

Sprzeciwiać się

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

SkuCapability

Sprzeciwiać się

Możliwość jednostki SKU, taka jak liczba rdzeni.

Nazwa	Typ	Opis
name	string	Nazwa funkcji.
value	string	Wartość funkcji.

SupportedSku

Sprzeciwiać się

Opisuje obsługiwaną jednostkę SKU usługi Batch.

Nazwa	Typ	Opis
batchSupportEndOfLife	string (date-time)	Czas wycofania tej jednostki SKU przez usługę Azure Batch.
capabilities	SkuCapability[]	Kolekcja możliwości, które obsługuje ta jednostka SKU.
familyName	string	Nazwa rodziny jednostki SKU.
name	string	Nazwa jednostki SKU.

SupportedSkusResult

Sprzeciwiać się

Odpowiedź operacji jednostki SKU obsługiwana przez listę usługi Batch.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony z elementami
value	SupportedSku[]	Elementy SupportedSku na tej stronie