Locations - List
Enumeración de ubicaciones de Cosmos DB y sus propiedades
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La operación se ha completado correctamente. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Ejemplos
CosmosDBLocationList
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15
Sample Response
{
"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"
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Backup |
Enumeración para indicar el tipo de redundancia del almacenamiento de copia de seguridad. |
Cloud |
Respuesta de error del servicio. |
Error |
Respuesta de error. |
Location |
Resultado de la obtención de la ubicación de Cosmos DB |
Location |
La respuesta de la operación List, que contiene ubicaciones de Cosmos DB y sus propiedades. |
Location |
Metadatos de ubicación de Cosmos DB |
Status |
Enumeración para indicar el estado de compilación actual de la región. |
BackupStorageRedundancy
Enumeración para indicar el tipo de redundancia del almacenamiento de copia de seguridad.
Nombre | Tipo | Description |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
CloudError
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
error |
Respuesta de error. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
LocationGetResult
Resultado de la obtención de la ubicación de Cosmos DB
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso único de la cuenta de base de datos. |
name |
string |
Nombre de la cuenta de base de datos. |
properties |
Metadatos de ubicación de Cosmos DB |
|
type |
string |
Tipo de recurso de Azure. |
LocationListResult
La respuesta de la operación List, que contiene ubicaciones de Cosmos DB y sus propiedades.
Nombre | Tipo | Description |
---|---|---|
value |
Lista de ubicaciones de Cosmos DB y sus propiedades. |
LocationProperties
Metadatos de ubicación de Cosmos DB
Nombre | Tipo | Description |
---|---|---|
backupStorageRedundancies |
Las propiedades de las redundancias de almacenamiento de copia de seguridad disponibles. |
|
isResidencyRestricted |
boolean |
Marca que indica si la ubicación es confidencial de residencia. |
isSubscriptionRegionAccessAllowedForAz |
boolean |
Marca que indica si la suscripción tiene acceso en la región para Availability Zones(Az). |
isSubscriptionRegionAccessAllowedForRegular |
boolean |
Marca que indica si la suscripción tiene acceso en la región para no Availability Zones. |
status |
Enumeración para indicar el estado de compilación actual de la región. |
|
supportsAvailabilityZone |
boolean |
Marca que indica si la ubicación admite zonas de disponibilidad o no. |
Status
Enumeración para indicar el estado de compilación actual de la región.
Nombre | Tipo | Description |
---|---|---|
Deleting |
string |
|
Initializing |
string |
|
InternallyReady |
string |
|
Online |
string |
|
Uninitialized |
string |