Subscriptions - List Locations

リファレンス

サービス:: Resource Management

API バージョン:: 2022-12-01

使用可能なすべての geo 場所を取得します。
この操作により、リソースプロバイダーで使用できるすべての場所が提供されます。ただし、各リソースプロバイダーは、このリストのサブセットをサポートする場合があります。

GET https://management.azure.com/subscriptions/{subscriptionId}/locations?api-version=2022-12-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/locations?api-version=2022-12-01&includeExtendedLocations={includeExtendedLocations}

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。
includeExtendedLocations	query		boolean	拡張された場所を含めるかどうか。

応答

名前	型	説明
200 OK	LocationListResult	OK - 場所の配列を返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

GetLocationsWithASubscriptionId

GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

要求のサンプル

GET https://management.azure.com/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations?api-version=2022-12-01


/**
 * Samples for Subscriptions ListLocations.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
     */
    /**
     * Sample code: GetLocationsWithASubscriptionId.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLocationsWithASubscriptionId(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .listLocations("a1ffc958-d2c7-493e-9f1e-125a0477f536", 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.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_locations.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 = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.list_locations(
        subscription_id="a1ffc958-d2c7-493e-9f1e-125a0477f536",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.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 armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
func ExampleClient_NewListLocationsPager_getLocationsWithASubscriptionId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListLocationsPager("a1ffc958-d2c7-493e-9f1e-125a0477f536", &armsubscriptions.ClientListLocationsOptions{IncludeExtendedLocations: 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.LocationListResult = armsubscriptions.LocationListResult{
		// 	Value: []*armsubscriptions.Location{
		// 		{
		// 			Name: to.Ptr("eastus"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("37.3719"),
		// 				Longitude: to.Ptr("-79.8164"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("westus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US"),
		// 		},
		// 		{
		// 			Name: to.Ptr("eastus2"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus2-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus2-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus2-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US 2"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("36.6681"),
		// 				Longitude: to.Ptr("-78.3889"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("centralus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US 2"),
		// 	}},
		// }
	}
}

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

const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 *
 * @summary This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
 */
async function getLocationsWithASubscriptionId() {
  const subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (let item of client.subscriptions.listLocations(subscriptionId)) {
    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.Resources.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
// this example is just showing the usage of "Subscriptions_ListLocations" 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 = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscription = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (LocationExpanded item in subscription.GetLocationsAsync())
{
    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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
      "name": "eastus",
      "type": "Region",
      "displayName": "East US",
      "regionalDisplayName": "(US) East US",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-79.8164",
        "latitude": "37.3719",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "westus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
      "name": "eastus2",
      "type": "Region",
      "displayName": "East US 2",
      "regionalDisplayName": "(US) East US 2",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-78.3889",
        "latitude": "36.6681",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "centralus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus2-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus2-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus2-az2"
        }
      ]
    }
  ]
}

GetLocationsWithExtendedLocations

要求のサンプル

GET https://management.azure.com/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations?api-version=2022-12-01&includeExtendedLocations=true


/**
 * Samples for Subscriptions ListLocations.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/
     * GetLocationsWithExtendedLocations.json
     */
    /**
     * Sample code: GetLocationsWithExtendedLocations.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLocationsWithExtendedLocations(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .listLocations("a1ffc958-d2c7-493e-9f1e-125a0477f536", true, 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.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_locations_with_extended_locations.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 = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.list_locations(
        subscription_id="a1ffc958-d2c7-493e-9f1e-125a0477f536",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.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 armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
func ExampleClient_NewListLocationsPager_getLocationsWithExtendedLocations() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListLocationsPager("a1ffc958-d2c7-493e-9f1e-125a0477f536", &armsubscriptions.ClientListLocationsOptions{IncludeExtendedLocations: to.Ptr(true)})
	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.LocationListResult = armsubscriptions.LocationListResult{
		// 	Value: []*armsubscriptions.Location{
		// 		{
		// 			Name: to.Ptr("eastus"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("37.3719"),
		// 				Longitude: to.Ptr("-79.8164"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("westus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US"),
		// 		},
		// 		{
		// 			Name: to.Ptr("eastus2"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus2-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus2-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus2-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US 2"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("36.6681"),
		// 				Longitude: to.Ptr("-78.3889"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("centralus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US 2"),
		// 		},
		// 		{
		// 			Name: to.Ptr("ezecustomerlabboston1"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeEdgeZone),
		// 			DisplayName: to.Ptr("EZE Customer Lab Boston 1"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("42.301218"),
		// 				Longitude: to.Ptr("-71.219038"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryExtended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) EZE Customer Lab Boston 1"),
		// 		},
		// 		{
		// 			Name: to.Ptr("ezecustomerlabhouston1"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeEdgeZone),
		// 			DisplayName: to.Ptr("EZE Customer Lab Houston 1"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("29.9411"),
		// 				Longitude: to.Ptr("-95.41452"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryExtended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) EZE Customer Lab Houston 1"),
		// 	}},
		// }
	}
}

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

const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 *
 * @summary This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
 */
async function getLocationsWithExtendedLocations() {
  const subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
  const includeExtendedLocations = true;
  const options = {
    includeExtendedLocations,
  };
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (let item of client.subscriptions.listLocations(subscriptionId, options)) {
    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.Resources.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
// this example is just showing the usage of "Subscriptions_ListLocations" 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 = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscription = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
bool? includeExtendedLocations = true;
await foreach (LocationExpanded item in subscription.GetLocationsAsync(includeExtendedLocations: includeExtendedLocations))
{
    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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
      "name": "eastus",
      "type": "Region",
      "displayName": "East US",
      "regionalDisplayName": "(US) East US",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-79.8164",
        "latitude": "37.3719",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "westus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
      "name": "eastus2",
      "type": "Region",
      "displayName": "East US 2",
      "regionalDisplayName": "(US) East US 2",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-78.3889",
        "latitude": "36.6681",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "centralus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus2-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus2-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus2-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1",
      "name": "ezecustomerlabboston1",
      "type": "EdgeZone",
      "displayName": "EZE Customer Lab Boston 1",
      "regionalDisplayName": "(US) EZE Customer Lab Boston 1",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Extended",
        "geographyGroup": "US",
        "geography": "United States",
        "longitude": "-71.219038",
        "latitude": "42.301218"
      }
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1",
      "name": "ezecustomerlabhouston1",
      "type": "EdgeZone",
      "displayName": "EZE Customer Lab Houston 1",
      "regionalDisplayName": "(US) EZE Customer Lab Houston 1",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Extended",
        "geographyGroup": "US",
        "geography": "United States",
        "longitude": "-95.41452",
        "latitude": "29.9411"
      }
    }
  ]
}

定義

名前	説明
AvailabilityZoneMappings	リージョンの可用性ゾーンマッピング
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Location	場所情報。
LocationListResult	場所リスト操作の応答。
LocationMetadata	場所のメタデータ情報
LocationType	場所の種類。
PairedRegion	ペアリージョンに関する情報。
RegionCategory	リージョンのカテゴリ。
RegionType	リージョンの型。

AvailabilityZoneMappings

リージョンの可用性ゾーンマッピング

名前	型	説明
logicalZone	string	可用性ゾーンの論理ゾーン ID
physicalZone	string	論理ゾーン ID がマップされる可用性ゾーンの完全修飾物理ゾーン ID

CloudError

リソース管理要求のエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

Location

場所情報。

名前	型	説明
availabilityZoneMappings	AvailabilityZoneMappings[]	このリージョンの可用性ゾーンマッピング。
displayName	string	場所の表示名。
id	string	場所の完全修飾 ID。たとえば、/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus です。
metadata	LocationMetadata	場所のメタデータ (lat/long、ペアリージョンなど)。
name	string	場所の名前。
regionalDisplayName	string	場所とその領域の表示名。
subscriptionId	string	サブスクリプション ID です。
type	LocationType	場所の種類。

LocationListResult

場所リスト操作の応答。

名前	型	説明
value	Location[]	場所の配列。

LocationMetadata

場所のメタデータ情報

名前	型	説明
geography	string	場所の地理。
geographyGroup	string	場所の geography グループ。
homeLocation	string	エッジゾーンのホーム位置。
latitude	string	場所の緯度。
longitude	string	場所の経度。
pairedRegion	PairedRegion[]	このリージョンとペアになったリージョン。
physicalLocation	string	Azure の場所の物理的な場所。
regionCategory	RegionCategory	リージョンのカテゴリ。
regionType	RegionType	リージョンの型。

LocationType

場所の種類。

名前	型	説明
EdgeZone	string
Region	string

PairedRegion

ペアリージョンに関する情報。

名前	型	説明
id	string	場所の完全修飾 ID。たとえば、/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus です。
name	string	ペアになったリージョンの名前。
subscriptionId	string	サブスクリプション ID です。

RegionCategory

リージョンのカテゴリ。

名前	型	説明
Extended	string
Other	string
Recommended	string

RegionType

リージョンの型。

名前	型	説明
Logical	string
Physical	string

次の方法で共有

Subscriptions - List Locations

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

GetLocationsWithASubscriptionId

要求のサンプル

応答のサンプル

GetLocationsWithExtendedLocations

要求のサンプル

応答のサンプル

定義

AvailabilityZoneMappings

CloudError

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Location

LocationListResult

LocationMetadata

LocationType

PairedRegion

RegionCategory

RegionType

その他のリソース