Location Get - Location Get

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=2021-04-01-preview

Parametry identyfikatora URI

Name In Required Type Description
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

Name Type Description
200 OK

Właściwości lokalizacji usługi Cosmos DB zostały pomyślnie pobrane.

Other Status Codes

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

Name Description
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=2021-04-01-preview

Sample Response

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

Definicje

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

CloudError

Odpowiedź błędu z usługi.

Name Type Description
error

Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
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

Name Type Description
id
  • string

Unikatowy identyfikator zasobu konta bazy danych.

name
  • string

Nazwa konta bazy danych.

properties

Metadane lokalizacji usługi Cosmos DB

type
  • string

Typ zasobu platformy Azure.

LocationProperties

Metadane lokalizacji usługi Cosmos DB

Name Type Description
backupStorageRedundancies
  • string[]

Właściwości dostępnych nadmiarowości magazynu kopii zapasowych.

isResidencyRestricted
  • boolean

Flaga wskazująca, czy lokalizacja jest wrażliwa na miejsce zamieszkania.

status
  • string

Bieżący stan lokalizacji na platformie Azure.

supportsAvailabilityZone
  • boolean

Flaga wskazująca, czy lokalizacja obsługuje strefy dostępności, czy nie.