Location - List Capabilities

Usługa:

Container Instances

Wersja interfejsu API:

2023-05-01

Pobierz listę możliwości lokalizacji.
Pobierz listę możliwości procesora CPU/pamięci/procesora GPU regionu.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities?api-version=2023-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string	Identyfikator lokalizacji fizycznej platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CapabilitiesListResult	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

GetCapabilities

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ContainerInstance/locations/westus/capabilities?api-version=2023-05-01

Java

/**
 * Samples for Location ListCapabilities.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/
     * CapabilitiesList.json
     */
    /**
     * Sample code: GetCapabilities.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getCapabilities(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.containerGroups().manager().serviceClient().getLocations().listCapabilities("westus",
            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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.containerinstance import ContainerInstanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerinstance
# USAGE
    python capabilities_list.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 = ContainerInstanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.location.list_capabilities(
        location="westus",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CapabilitiesList.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

Go

package armcontainerinstance_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e60df62e9e0d88462e6abba81a76d94eab000f0d/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CapabilitiesList.json
func ExampleLocationClient_NewListCapabilitiesPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerinstance.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLocationClient().NewListCapabilitiesPager("westus", 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.CapabilitiesListResult = armcontainerinstance.CapabilitiesListResult{
		// 	Value: []*armcontainerinstance.Capabilities{
		// 		{
		// 			Capabilities: &armcontainerinstance.CapabilitiesCapabilities{
		// 				MaxCPU: to.Ptr[float32](4),
		// 				MaxGpuCount: to.Ptr[float32](4),
		// 				MaxMemoryInGB: to.Ptr[float32](14),
		// 			},
		// 			Gpu: to.Ptr("K80"),
		// 			IPAddressType: to.Ptr("Public"),
		// 			Location: to.Ptr("West US"),
		// 			OSType: to.Ptr("Linux"),
		// 			ResourceType: to.Ptr("containerGroups"),
		// 		},
		// 		{
		// 			Capabilities: &armcontainerinstance.CapabilitiesCapabilities{
		// 				MaxCPU: to.Ptr[float32](4),
		// 				MaxGpuCount: to.Ptr[float32](0),
		// 				MaxMemoryInGB: to.Ptr[float32](14),
		// 			},
		// 			Gpu: to.Ptr("None"),
		// 			IPAddressType: to.Ptr("Public"),
		// 			Location: to.Ptr("West US"),
		// 			OSType: to.Ptr("Windows"),
		// 			ResourceType: to.Ptr("containerGroups"),
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Get the list of CPU/memory/GPU capabilities of a region.
 *
 * @summary Get the list of CPU/memory/GPU capabilities of a region.
 * x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CapabilitiesList.json
 */
async function getCapabilities() {
  const subscriptionId = process.env["CONTAINERINSTANCE_SUBSCRIPTION_ID"] || "subid";
  const location = "westus";
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.location.listCapabilities(location)) {
    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

dotnet

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

// Generated from example definition: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CapabilitiesList.json
// this example is just showing the usage of "Location_ListCapabilities" 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 location = new AzureLocation("westus");
await foreach (ContainerCapabilities item in subscriptionResource.GetCapabilitiesWithLocationAsync(location))
{
    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 stanu:

200

{
  "value": [
    {
      "resourceType": "containerGroups",
      "osType": "Linux",
      "location": "West US",
      "ipAddressType": "Public",
      "gpu": "K80",
      "capabilities": {
        "maxMemoryInGB": 14,
        "maxCpu": 4,
        "maxGpuCount": 4
      }
    },
    {
      "resourceType": "containerGroups",
      "osType": "Windows",
      "location": "West US",
      "ipAddressType": "Public",
      "gpu": "None",
      "capabilities": {
        "maxMemoryInGB": 14,
        "maxCpu": 4,
        "maxGpuCount": 0
      }
    }
  ]
}

Definicje

Nazwa	Opis
Capabilities	Możliwości regionalne.
CapabilitiesListResult	Odpowiedź zawierająca listę możliwości.
CloudError	Odpowiedź o błędzie z usługi Container Instance.
CloudErrorBody	Odpowiedź o błędzie z usługi Container Instance.

Capabilities

Możliwości regionalne.

Nazwa	Typ	Opis
capabilities	Capabilities	Obsługiwane możliwości.
gpu	string	Jednostka SKU procesora GPU, którą opisuje ta funkcja.
ipAddressType	string	Typ adresu IP, który opisuje ta funkcja.
location	string	Lokalizacja zasobu.
osType	string	Typ systemu operacyjnego, który opisuje ta funkcja.
resourceType	string	Typ zasobu, który opisuje ta funkcja.

CapabilitiesListResult

Odpowiedź zawierająca listę możliwości.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony możliwości.
value	Capabilities[]	Lista możliwości.

CloudError

Odpowiedź o błędzie z usługi Container Instance.

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź o błędzie z usługi Container Instance.

CloudErrorBody

Odpowiedź o błędzie z usługi Container Instance.

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.