Partilhar via


Locations - List

Listar localizações do Cosmos DB e as respetivas propriedades

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

LocationListResult

A operação foi concluída com êxito.

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation Representar a sua conta de utilizador

Exemplos

CosmosDBLocationList

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
BackupStorageRedundancy

Enum para indicar o tipo de redundância do armazenamento de cópias de segurança.

CloudError

Uma resposta de erro do serviço.

ErrorResponse

Resposta a Erros.

LocationGetResult

A localização do Cosmos DB obtém o resultado

LocationListResult

A resposta da operação Lista, que contém localizações do Cosmos DB e as respetivas propriedades.

LocationProperties

Metadados de localização do Cosmos DB

Status

Enum para indicar o estado atual da compilação da região.

BackupStorageRedundancy

Enum para indicar o tipo de redundância do armazenamento de cópias de segurança.

Name Tipo Description
Geo

string

Local

string

Zone

string

CloudError

Uma resposta de erro do serviço.

Name Tipo Description
error

ErrorResponse

Resposta a Erros.

ErrorResponse

Resposta a Erros.

Name Tipo Description
code

string

Código de erro.

message

string

Mensagem de erro a indicar por que motivo a operação falhou.

LocationGetResult

A localização do Cosmos DB obtém o resultado

Name Tipo Description
id

string

O identificador de recurso exclusivo da conta de base de dados.

name

string

O nome da conta da base de dados.

properties

LocationProperties

Metadados de localização do Cosmos DB

type

string

O tipo de recurso do Azure.

LocationListResult

A resposta da operação Lista, que contém localizações do Cosmos DB e as respetivas propriedades.

Name Tipo Description
value

LocationGetResult[]

Lista de localizações do Cosmos DB e respetivas propriedades.

LocationProperties

Metadados de localização do Cosmos DB

Name Tipo Description
backupStorageRedundancies

BackupStorageRedundancy[]

As propriedades das redundâncias de armazenamento de cópias de segurança disponíveis.

isResidencyRestricted

boolean

Sinalizador a indicar se a localização é sensível à residência.

isSubscriptionRegionAccessAllowedForAz

boolean

Sinalizador a indicar se a subscrição tem acesso na região para Zonas de Disponibilidade(Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Sinalizador a indicar se a subscrição tem acesso na região para Non-Zonas de Disponibilidade.

status

Status

Enum para indicar o estado atual da compilação da região.

supportsAvailabilityZone

boolean

Sinalizador a indicar se a localização suporta ou não zonas de disponibilidade.

Status

Enum para indicar o estado atual da compilação da região.

Name Tipo Description
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string