Locations - List

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Cosmos DB-helyek és tulajdonságaik listázása

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	LocationListResult	A művelet sikeresen befejeződött.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	A felhasználói fiók megszemélyesítése

Példák

CosmosDBLocationList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15

Java

/**
 * Samples for Locations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.
     * json
     */
    /**
     * Sample code: CosmosDBLocationList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBLocationList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getLocations().list(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.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_location_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 = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.locations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.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 armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.json
func ExampleLocationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLocationsClient().NewListPager(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 = armcosmos.LocationListResult{
		// 	Value: []*armcosmos.LocationGetResult{
		// 		{
		// 			Name: to.Ptr("westus"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus"),
		// 			Properties: &armcosmos.LocationProperties{
		// 				BackupStorageRedundancies: []*armcosmos.BackupStorageRedundancy{
		// 					to.Ptr(armcosmos.BackupStorageRedundancyLocal),
		// 					to.Ptr(armcosmos.BackupStorageRedundancyGeo)},
		// 					IsResidencyRestricted: to.Ptr(false),
		// 					IsSubscriptionRegionAccessAllowedForAz: to.Ptr(false),
		// 					IsSubscriptionRegionAccessAllowedForRegular: to.Ptr(true),
		// 					Status: to.Ptr(armcosmos.StatusOnline),
		// 					SupportsAvailabilityZone: to.Ptr(false),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("centralus"),
		// 				Type: to.Ptr("Microsoft.DocumentDB/locations"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/centralus"),
		// 				Properties: &armcosmos.LocationProperties{
		// 					BackupStorageRedundancies: []*armcosmos.BackupStorageRedundancy{
		// 						to.Ptr(armcosmos.BackupStorageRedundancyZone),
		// 						to.Ptr(armcosmos.BackupStorageRedundancyGeo)},
		// 						IsResidencyRestricted: to.Ptr(false),
		// 						IsSubscriptionRegionAccessAllowedForAz: to.Ptr(true),
		// 						IsSubscriptionRegionAccessAllowedForRegular: to.Ptr(false),
		// 						Status: to.Ptr(armcosmos.StatusOnline),
		// 						SupportsAvailabilityZone: to.Ptr(true),
		// 					},
		// 			}},
		// 		}
	}
}

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 { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List Cosmos DB locations and their properties
 *
 * @summary List Cosmos DB locations and their properties
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.json
 */
async function cosmosDbLocationList() {
  const subscriptionId =
    process.env["COSMOSDB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.locations.list()) {
    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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus",
      "type": "Microsoft.DocumentDB/locations",
      "name": "westus",
      "properties": {
        "supportsAvailabilityZone": false,
        "isResidencyRestricted": false,
        "backupStorageRedundancies": [
          "Local",
          "Geo"
        ],
        "isSubscriptionRegionAccessAllowedForRegular": true,
        "isSubscriptionRegionAccessAllowedForAz": false,
        "status": "Online"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/centralus",
      "type": "Microsoft.DocumentDB/locations",
      "name": "centralus",
      "properties": {
        "supportsAvailabilityZone": true,
        "isResidencyRestricted": false,
        "backupStorageRedundancies": [
          "Zone",
          "Geo"
        ],
        "isSubscriptionRegionAccessAllowedForRegular": false,
        "isSubscriptionRegionAccessAllowedForAz": true,
        "status": "Online"
      }
    }
  ]
}

Definíciók

Name	Description
BackupStorageRedundancy	Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.
CloudError	Hibaválasz a szolgáltatástól.
ErrorResponse	Hibaválasz.
LocationGetResult	Cosmos DB-hely lekérése eredmény
LocationListResult	A List művelet válasza, amely a Cosmos DB-helyeket és azok tulajdonságait tartalmazza.
LocationProperties	Cosmos DB-hely metaadatai
Status	Enumerálás a régió aktuális buildelési állapotának jelzéséhez.

BackupStorageRedundancy

Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.

Name	Típus	Description
Geo	string
Local	string
Zone	string

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	ErrorResponse	Hibaválasz.

ErrorResponse

Hibaválasz.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

LocationGetResult

Cosmos DB-hely lekérése eredmény

Name	Típus	Description
id	string	Az adatbázisfiók egyedi erőforrás-azonosítója.
name	string	Az adatbázisfiók neve.
properties	LocationProperties	Cosmos DB-hely metaadatai
type	string	Az Azure-erőforrás típusa.

LocationListResult

A List művelet válasza, amely a Cosmos DB-helyeket és azok tulajdonságait tartalmazza.

Name	Típus	Description
value	LocationGetResult[]	A Cosmos DB-helyek és tulajdonságaik listája.

LocationProperties

Cosmos DB-hely metaadatai

Name	Típus	Description
backupStorageRedundancies	BackupStorageRedundancy[]	Az elérhető biztonsági mentési tár redundanciáinak tulajdonságai.
isResidencyRestricted	boolean	Jelölő, amely jelzi, hogy a hely bizalmas-e a tartózkodási hely számára.
isSubscriptionRegionAccessAllowedForAz	boolean	Jelölő, amely azt jelzi, hogy az előfizetés rendelkezik-e hozzáféréssel az Availability Zones(Az) régióban.
isSubscriptionRegionAccessAllowedForRegular	boolean	Jelölő, amely jelzi, hogy az előfizetés rendelkezik-e hozzáféréssel a nem Availability Zones régióban.
status	Status	Enumerálás a régió aktuális buildelési állapotának jelzéséhez.
supportsAvailabilityZone	boolean	Jelző, amely jelzi, hogy a hely támogatja-e a rendelkezésre állási zónákat.

Status

Enumerálás a régió aktuális buildelési állapotának jelzéséhez.

Name	Típus	Description
Deleting	string
Initializing	string
InternallyReady	string
Online	string
Uninitialized	string