Location Get - Location Get

Abrufen der Eigenschaften eines vorhandenen Cosmos DB-Speicherorts

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}?api-version=2021-04-01-preview

URI-Parameter

Name In Required Type Description
location
path True
  • string

Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort groß geschrieben.

subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Type Description
200 OK

Die Standorteigenschaften von Cosmos DB wurden erfolgreich abgerufen.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
    ]
  }
}

Definitionen

CloudError

Eine Fehlerantwort vom Dienst.

ErrorResponse

Fehlerantwort.

LocationGetResult

Cosmos DB-Speicherort erhalten Ergebnis

LocationProperties

Cosmos DB-Speicherortmetadaten

CloudError

Eine Fehlerantwort vom Dienst.

Name Type Description
error

Fehlerantwort.

ErrorResponse

Fehlerantwort.

Name Type Description
code
  • string

Fehlercode

message
  • string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

LocationGetResult

Cosmos DB-Speicherort erhalten Ergebnis

Name Type Description
id
  • string

Der eindeutige Ressourcenbezeichner des Datenbankkontos.

name
  • string

Der Name des Datenbankkontos.

properties

Cosmos DB-Speicherortmetadaten

type
  • string

Der Typ der Azure-Ressource.

LocationProperties

Cosmos DB-Speicherortmetadaten

Name Type Description
backupStorageRedundancies
  • string[]

Die Eigenschaften der verfügbaren Speicherredundanzen.

isResidencyRestricted
  • boolean

Flag, das angibt, ob der Standort vertraulich ist.

status
  • string

Der aktuelle Status des Speicherorts in Azure.

supportsAvailabilityZone
  • boolean

Flag, das angibt, ob der Standort Verfügbarkeitszonen unterstützt oder nicht.