Partager via


Locations - List

Répertorier les emplacements Cosmos DB et leurs propriétés

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

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

LocationListResult

L’opération s’est terminée avec succès.

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBLocationList

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
BackupStorageRedundancy

Énumérez pour indiquer le type de redondance du stockage de sauvegarde.

CloudError

Réponse d’erreur du service.

ErrorResponse

Réponse d’erreur.

LocationGetResult

Obtenir le résultat de l’emplacement Cosmos DB

LocationListResult

Réponse de l’opération List, qui contient les emplacements Cosmos DB et leurs propriétés.

LocationProperties

Métadonnées d’emplacement Cosmos DB

Status

Énumérez pour indiquer la génération actuelle status de la région.

BackupStorageRedundancy

Énumérez pour indiquer le type de redondance du stockage de sauvegarde.

Nom Type Description
Geo

string

Local

string

Zone

string

CloudError

Réponse d’erreur du service.

Nom Type Description
error

ErrorResponse

Réponse d’erreur.

ErrorResponse

Réponse d’erreur.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur indiquant la raison de l’échec de l’opération.

LocationGetResult

Obtenir le résultat de l’emplacement Cosmos DB

Nom Type Description
id

string

Identificateur de ressource unique du compte de base de données.

name

string

Nom du compte de base de données.

properties

LocationProperties

Métadonnées d’emplacement Cosmos DB

type

string

Type de ressource Azure.

LocationListResult

Réponse de l’opération List, qui contient les emplacements Cosmos DB et leurs propriétés.

Nom Type Description
value

LocationGetResult[]

Liste des emplacements Cosmos DB et de leurs propriétés.

LocationProperties

Métadonnées d’emplacement Cosmos DB

Nom Type Description
backupStorageRedundancies

BackupStorageRedundancy[]

Propriétés des redondances de stockage de sauvegarde disponibles.

isResidencyRestricted

boolean

Indicateur indiquant si l’emplacement est sensible à la résidence.

isSubscriptionRegionAccessAllowedForAz

boolean

Indicateur indiquant si l’abonnement a accès dans la région pour Zones de disponibilité(Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Indicateur indiquant si l’abonnement a accès dans la région pour les non-Zones de disponibilité.

status

Status

Énumérez pour indiquer la génération actuelle status de la région.

supportsAvailabilityZone

boolean

Indicateur indiquant si l’emplacement prend en charge les zones de disponibilité ou non.

Status

Énumérez pour indiquer la génération actuelle status de la région.

Nom Type Description
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string