Sdílet prostřednictvím


Locations - List

Výpis umístění služby Cosmos DB a jejich vlastností

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

LocationListResult

Operace se úspěšně dokončila.

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobnění uživatelského účtu

Příklady

CosmosDBLocationList

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
BackupStorageRedundancy

Výčet označující typ redundance úložiště zálohování

CloudError

Chybová odpověď ze služby.

ErrorResponse

Odpověď na chybu.

LocationGetResult

Získání výsledku umístění služby Cosmos DB

LocationListResult

Odpověď operace list, která obsahuje umístění služby Cosmos DB a jejich vlastnosti.

LocationProperties

Metadata umístění služby Cosmos DB

Status

Výčet pro označení aktuálního stavu sestavení oblasti

BackupStorageRedundancy

Výčet označující typ redundance úložiště zálohování

Name Typ Description
Geo

string

Local

string

Zone

string

CloudError

Chybová odpověď ze služby.

Name Typ Description
error

ErrorResponse

Odpověď na chybu.

ErrorResponse

Odpověď na chybu.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva označující, proč operace selhala.

LocationGetResult

Získání výsledku umístění služby Cosmos DB

Name Typ Description
id

string

Jedinečný identifikátor prostředku databázového účtu.

name

string

Název databázového účtu.

properties

LocationProperties

Metadata umístění služby Cosmos DB

type

string

Typ prostředku Azure.

LocationListResult

Odpověď operace list, která obsahuje umístění služby Cosmos DB a jejich vlastnosti.

Name Typ Description
value

LocationGetResult[]

Seznam umístění služby Cosmos DB a jejich vlastností

LocationProperties

Metadata umístění služby Cosmos DB

Name Typ Description
backupStorageRedundancies

BackupStorageRedundancy[]

Vlastnosti dostupných redundancí úložiště zálohování.

isResidencyRestricted

boolean

Příznak označující, jestli je umístění citlivé na rezidenci.

isSubscriptionRegionAccessAllowedForAz

boolean

Příznak označující, jestli má předplatné přístup v oblasti pro Zóny dostupnosti(Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Příznak označující, jestli má předplatné přístup v oblasti pro Zóny dostupnosti.

status

Status

Výčet pro označení aktuálního stavu sestavení oblasti

supportsAvailabilityZone

boolean

Příznak označující, jestli umístění podporuje zóny dostupnosti nebo ne.

Status

Výčet pro označení aktuálního stavu sestavení oblasti

Name Typ Description
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string