Locations - List
Wyświetlanie listy lokalizacji usługi Cosmos DB i ich właściwości
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Operacja została ukończona pomyślnie. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | Personifikuj konto użytkownika |
Przykłady
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"
}
}
]
}
Definicje
Nazwa | Opis |
---|---|
Backup |
Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych. |
Cloud |
Odpowiedź błędu z usługi. |
Error |
Odpowiedź na błąd. |
Location |
Wynik pobierania lokalizacji usługi Cosmos DB |
Location |
Odpowiedź operacji Lista zawierająca lokalizacje usługi Cosmos DB i ich właściwości. |
Location |
Metadane lokalizacji usługi Cosmos DB |
Status |
Wyliczenie wskazujące bieżący stan kompilacji regionu. |
BackupStorageRedundancy
Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych.
Nazwa | Typ | Opis |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
CloudError
Odpowiedź błędu z usługi.
Nazwa | Typ | Opis |
---|---|---|
error |
Odpowiedź na błąd. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
LocationGetResult
Wynik pobierania lokalizacji usługi Cosmos DB
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Unikatowy identyfikator zasobu konta bazy danych. |
name |
string |
Nazwa konta bazy danych. |
properties |
Metadane lokalizacji usługi Cosmos DB |
|
type |
string |
Typ zasobu platformy Azure. |
LocationListResult
Odpowiedź operacji Lista zawierająca lokalizacje usługi Cosmos DB i ich właściwości.
Nazwa | Typ | Opis |
---|---|---|
value |
Lista lokalizacji usługi Cosmos DB i ich właściwości. |
LocationProperties
Metadane lokalizacji usługi Cosmos DB
Nazwa | Typ | Opis |
---|---|---|
backupStorageRedundancies |
Właściwości dostępnych nadmiarowości magazynu kopii zapasowych. |
|
isResidencyRestricted |
boolean |
Flaga wskazująca, czy lokalizacja jest wrażliwa na miejsce zamieszkania. |
isSubscriptionRegionAccessAllowedForAz |
boolean |
Flaga wskazująca, czy subskrypcja ma dostęp w regionie dla Strefy dostępności(Az). |
isSubscriptionRegionAccessAllowedForRegular |
boolean |
Flaga wskazująca, czy subskrypcja ma dostęp w regionie dla Strefy dostępności innych niż. |
status |
Wyliczenie wskazujące bieżący stan kompilacji regionu. |
|
supportsAvailabilityZone |
boolean |
Flaga wskazująca, czy lokalizacja obsługuje strefy dostępności, czy nie. |
Status
Wyliczenie wskazujące bieżący stan kompilacji regionu.
Nazwa | Typ | Opis |
---|---|---|
Deleting |
string |
|
Initializing |
string |
|
InternallyReady |
string |
|
Online |
string |
|
Uninitialized |
string |