Megosztás a következőn keresztül:


Locations - List

Cosmos DB-helyek és tulajdonságaik listázása

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

URI-paraméterek

Name In Kötelező Típus Description
subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Válaszok

Name Típus Description
200 OK

LocationListResult

A művelet sikeresen befejeződött.

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation A felhasználói fiók megszemélyesítése

Példák

CosmosDBLocationList

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
BackupStorageRedundancy

Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.

CloudError

Hibaválasz a szolgáltatástól.

ErrorResponse

Hibaválasz.

LocationGetResult

Cosmos DB-hely lekérése eredmény

LocationListResult

A List művelet válasza, amely a Cosmos DB-helyeket és azok tulajdonságait tartalmazza.

LocationProperties

Cosmos DB-hely metaadatai

Status

Enumerálás a régió aktuális buildelési állapotának jelzéséhez.

BackupStorageRedundancy

Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.

Name Típus Description
Geo

string

Local

string

Zone

string

CloudError

Hibaválasz a szolgáltatástól.

Name Típus Description
error

ErrorResponse

Hibaválasz.

ErrorResponse

Hibaválasz.

Name Típus Description
code

string

Hibakód.

message

string

Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

LocationGetResult

Cosmos DB-hely lekérése eredmény

Name Típus Description
id

string

Az adatbázisfiók egyedi erőforrás-azonosítója.

name

string

Az adatbázisfiók neve.

properties

LocationProperties

Cosmos DB-hely metaadatai

type

string

Az Azure-erőforrás típusa.

LocationListResult

A List művelet válasza, amely a Cosmos DB-helyeket és azok tulajdonságait tartalmazza.

Name Típus Description
value

LocationGetResult[]

A Cosmos DB-helyek és tulajdonságaik listája.

LocationProperties

Cosmos DB-hely metaadatai

Name Típus Description
backupStorageRedundancies

BackupStorageRedundancy[]

Az elérhető biztonsági mentési tár redundanciáinak tulajdonságai.

isResidencyRestricted

boolean

Jelölő, amely jelzi, hogy a hely bizalmas-e a tartózkodási hely számára.

isSubscriptionRegionAccessAllowedForAz

boolean

Jelölő, amely azt jelzi, hogy az előfizetés rendelkezik-e hozzáféréssel az Availability Zones(Az) régióban.

isSubscriptionRegionAccessAllowedForRegular

boolean

Jelölő, amely jelzi, hogy az előfizetés rendelkezik-e hozzáféréssel a nem Availability Zones régióban.

status

Status

Enumerálás a régió aktuális buildelési állapotának jelzéséhez.

supportsAvailabilityZone

boolean

Jelző, amely jelzi, hogy a hely támogatja-e a rendelkezésre állási zónákat.

Status

Enumerálás a régió aktuális buildelési állapotának jelzéséhez.

Name Típus Description
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string