Freigeben über


Locations - List

Auflisten von Cosmos DB-Standorten und deren Eigenschaften

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
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 Typ Beschreibung
200 OK

LocationListResult

Der Vorgang wurde erfolgreich abgeschlossen.

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBLocationList

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BackupStorageRedundancy

Enumeration, um den Typ der Sicherungsspeicherredundanz anzugeben.

CloudError

Eine Fehlerantwort vom Dienst.

ErrorResponse

Fehlerantwort.

LocationGetResult

Cosmos DB-Standort erhält Ergebnis

LocationListResult

Die List-Vorgangsantwort, die Cosmos DB-Speicherorte und deren Eigenschaften enthält.

LocationProperties

Cosmos DB-Standortmetadaten

Status

Enumeration, um den aktuellen Buildout-status der Region anzugeben.

BackupStorageRedundancy

Enumeration, um den Typ der Sicherungsspeicherredundanz anzugeben.

Name Typ Beschreibung
Geo

string

Local

string

Zone

string

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode

message

string

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

LocationGetResult

Cosmos DB-Standort erhält Ergebnis

Name Typ Beschreibung
id

string

Der eindeutige Ressourcenbezeichner des Datenbankkontos.

name

string

Der Name des Datenbankkontos.

properties

LocationProperties

Cosmos DB-Standortmetadaten

type

string

Der Typ der Azure-Ressource.

LocationListResult

Die List-Vorgangsantwort, die Cosmos DB-Speicherorte und deren Eigenschaften enthält.

Name Typ Beschreibung
value

LocationGetResult[]

Liste der Cosmos DB-Standorte und deren Eigenschaften.

LocationProperties

Cosmos DB-Standortmetadaten

Name Typ Beschreibung
backupStorageRedundancies

BackupStorageRedundancy[]

Die Eigenschaften der verfügbaren Sicherungsspeicherredundanzen.

isResidencyRestricted

boolean

Flag, das angibt, ob der Standort wohnsitzabhängig ist.

isSubscriptionRegionAccessAllowedForAz

boolean

Flag, das angibt, ob das Abonnement Zugriff in der Region für Verfügbarkeitszonen(Az) hat.

isSubscriptionRegionAccessAllowedForRegular

boolean

Flag, das angibt, ob das Abonnement Zugriff in der Region für Nicht-Verfügbarkeitszonen hat.

status

Status

Enumeration, um den aktuellen Buildout-status der Region anzugeben.

supportsAvailabilityZone

boolean

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

Status

Enumeration, um den aktuellen Buildout-status der Region anzugeben.

Name Typ Beschreibung
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string