Condividi tramite


Locations - List

Elencare le posizioni di Cosmos DB e le relative proprietà

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

LocationListResult

Operazione riuscita.

Other Status Codes

CloudError

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Rappresentare l'account utente

Esempio

CosmosDBLocationList

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
BackupStorageRedundancy

Enumerazione per indicare il tipo di ridondanza dell'archiviazione di backup.

CloudError

Risposta di errore dal servizio.

ErrorResponse

Risposta errore.

LocationGetResult

Percorso cosmos DB get result

LocationListResult

Risposta dell'operazione List che contiene posizioni cosmos DB e le relative proprietà.

LocationProperties

Metadati della posizione di Cosmos DB

Status

Enumerazione per indicare lo stato di compilazione corrente dell'area.

BackupStorageRedundancy

Enumerazione per indicare il tipo di ridondanza dell'archiviazione di backup.

Nome Tipo Descrizione
Geo

string

Local

string

Zone

string

CloudError

Risposta di errore dal servizio.

Nome Tipo Descrizione
error

ErrorResponse

Risposta errore.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore che indica perché l'operazione non è riuscita.

LocationGetResult

Percorso cosmos DB get result

Nome Tipo Descrizione
id

string

Identificatore univoco della risorsa dell'account del database.

name

string

Nome dell'account del database.

properties

LocationProperties

Metadati della posizione di Cosmos DB

type

string

Tipo di risorsa di Azure.

LocationListResult

Risposta dell'operazione List che contiene posizioni cosmos DB e le relative proprietà.

Nome Tipo Descrizione
value

LocationGetResult[]

Elenco delle posizioni di Cosmos DB e delle relative proprietà.

LocationProperties

Metadati della posizione di Cosmos DB

Nome Tipo Descrizione
backupStorageRedundancies

BackupStorageRedundancy[]

Proprietà delle ridondanza dell'archiviazione di backup disponibili.

isResidencyRestricted

boolean

Flag che indica se la posizione è sensibile alla residenza.

isSubscriptionRegionAccessAllowedForAz

boolean

Flag che indica se la sottoscrizione ha accesso nell'area per zone di disponibilità(Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Flag che indica se la sottoscrizione ha accesso nell'area per non zone di disponibilità.

status

Status

Enumerazione per indicare lo stato di compilazione corrente dell'area.

supportsAvailabilityZone

boolean

Flag che indica se la posizione supporta le zone di disponibilità o meno.

Status

Enumerazione per indicare lo stato di compilazione corrente dell'area.

Nome Tipo Descrizione
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string