Locations - Get

Odwołanie

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Pobieranie właściwości istniejącej lokalizacji usługi Cosmos DB

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string	Region usługi Cosmos DB ze spacjami między wyrazami a każdym wyrazem z literami.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LocationGetResult	Właściwości lokalizacji usługi Cosmos DB zostały pomyślnie pobrane.
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

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBLocationGet

Sample Request

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


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

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_get.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.get(
        location="westus",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationGet.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 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/CosmosDBLocationGet.json
func ExampleLocationsClient_Get() {
	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)
	}
	res, err := clientFactory.NewLocationsClient().Get(ctx, "westus", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LocationGetResult = 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(true),
	// 			IsSubscriptionRegionAccessAllowedForAz: to.Ptr(true),
	// 			IsSubscriptionRegionAccessAllowedForRegular: to.Ptr(true),
	// 			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

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

/**
 * This sample demonstrates how to Get the properties of an existing Cosmos DB location
 *
 * @summary Get the properties of an existing Cosmos DB location
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationGet.json
 */
async function cosmosDbLocationGet() {
  const subscriptionId =
    process.env["COSMOSDB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "westus";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.locations.get(location);
  console.log(result);
}

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

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

Definicje

Nazwa	Opis
BackupStorageRedundancy	Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych.
CloudError	Odpowiedź błędu z usługi.
ErrorResponse	Odpowiedź na błąd.
LocationGetResult	Wynik pobierania lokalizacji usługi Cosmos DB
LocationProperties	Metadane lokalizacji usługi Cosmos DB
Status	Wyliczenie wskazujące bieżący stan kompilacji regionu.

BackupStorageRedundancy

Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych.

Nazwa	Typ	Opis
Geo	string
Local	string
Zone	string

CloudError

Odpowiedź błędu z usługi.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

LocationGetResult

Wynik pobierania lokalizacji usługi Cosmos DB

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu konta bazy danych.
name	string	Nazwa konta bazy danych.
properties	LocationProperties	Metadane lokalizacji usługi Cosmos DB
type	string	Typ zasobu platformy Azure.

LocationProperties

Metadane lokalizacji usługi Cosmos DB

Nazwa	Typ	Opis
backupStorageRedundancies	BackupStorageRedundancy[]	Właściwości dostępnych nadmiarowości magazynu kopii zapasowych.
isResidencyRestricted	boolean	Flaga wskazująca, czy lokalizacja jest wrażliwa na miejsce zamieszkania.
isSubscriptionRegionAccessAllowedForAz	boolean	Flaga wskazująca, czy subskrypcja ma dostęp w regionie dla Strefy dostępności(Az).
isSubscriptionRegionAccessAllowedForRegular	boolean	Flaga wskazująca, czy subskrypcja ma dostęp w regionie dla Strefy dostępności innych niż.
status	Status	Wyliczenie wskazujące bieżący stan kompilacji regionu.
supportsAvailabilityZone	boolean	Flaga wskazująca, czy lokalizacja obsługuje strefy dostępności, czy nie.

Status

Wyliczenie wskazujące bieżący stan kompilacji regionu.

Nazwa	Typ	Opis
Deleting	string
Initializing	string
InternallyReady	string
Online	string
Uninitialized	string

Locations - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

CosmosDBLocationGet

Sample Request

Sample Response

Definicje

BackupStorageRedundancy

CloudError

ErrorResponse

LocationGetResult

LocationProperties

Status

Dodatkowe zasoby