Location Get - Location Get

Obtención de las propiedades de una ubicación de Cosmos DB existente

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

Parámetros de identificador URI

Name In Required Type Description
location
path True
  • string

Región de Cosmos DB, con espacios entre palabras y cada palabra en mayúsculas.

subscriptionId
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

Name Type Description
200 OK

Las propiedades de ubicación de Cosmos DB se recuperaron correctamente.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation Suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

CloudError

Respuesta de error del servicio.

ErrorResponse

Respuesta de error.

LocationGetResult

Resultado de la obtención de la ubicación de Cosmos DB

LocationProperties

Metadatos de ubicación de Cosmos DB

CloudError

Respuesta de error del servicio.

Name Type Description
error

Respuesta de error.

ErrorResponse

Respuesta de error.

Name Type 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

Name Type 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.

LocationProperties

Metadatos de ubicación de Cosmos DB

Name Type Description
backupStorageRedundancies
  • string[]

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.

status
  • string

Estado actual de la ubicación en Azure.

supportsAvailabilityZone
  • boolean

Marca que indica si la ubicación admite zonas de disponibilidad o no.