Locations - List
Listar locais do Cosmos DB e suas propriedades
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A operação foi concluída com sucesso. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Exemplos
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"
}
}
]
}
Definições
Nome | Description |
---|---|
Backup |
Enumeração para indicar o tipo de redundância de armazenamento de backup. |
Cloud |
Uma resposta de erro do serviço. |
Error |
Resposta de erro. |
Location |
Resultado da obtenção da localização do Cosmos DB |
Location |
A resposta da operação Lista, que contém locais do Cosmos DB e suas propriedades. |
Location |
Metadados de localização do Cosmos DB |
Status |
Enumeração para indicar o buildout atual status da região. |
BackupStorageRedundancy
Enumeração para indicar o tipo de redundância de armazenamento de backup.
Nome | Tipo | Description |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
CloudError
Uma resposta de erro do serviço.
Nome | Tipo | Description |
---|---|---|
error |
Resposta de erro. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
message |
string |
Mensagem de erro indicando por que a operação falhou. |
LocationGetResult
Resultado da obtenção da localização do Cosmos DB
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador de recurso exclusivo da conta de banco de dados. |
name |
string |
O nome da conta de banco de dados. |
properties |
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 locais do Cosmos DB e suas propriedades.
Nome | Tipo | Description |
---|---|---|
value |
Lista de locais do Cosmos DB e suas propriedades. |
LocationProperties
Metadados de localização do Cosmos DB
Nome | Tipo | Description |
---|---|---|
backupStorageRedundancies |
As propriedades das redundâncias de armazenamento de backup disponíveis. |
|
isResidencyRestricted |
boolean |
Sinalizador que indica se o local é sensível à residência. |
isSubscriptionRegionAccessAllowedForAz |
boolean |
Sinalizador que indica se a assinatura tem acesso na região para Zonas de Disponibilidade(Az). |
isSubscriptionRegionAccessAllowedForRegular |
boolean |
Sinalizador que indica se a assinatura tem acesso na região para não Zonas de Disponibilidade. |
status |
Enumeração para indicar o buildout atual status da região. |
|
supportsAvailabilityZone |
boolean |
Sinalizador que indica se o local dá suporte a zonas de disponibilidade ou não. |
Status
Enumeração para indicar o buildout atual status da região.
Nome | Tipo | Description |
---|---|---|
Deleting |
string |
|
Initializing |
string |
|
InternallyReady |
string |
|
Online |
string |
|
Uninitialized |
string |