Bagikan melalui


Locations - List

Mencantumkan lokasi Cosmos DB dan propertinya

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
subscriptionId
path True

string

ID langganan target.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Respons

Nama Jenis Deskripsi
200 OK

LocationListResult

Operasi berhasil diselesaikan.

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation Meniru akun pengguna Anda

Contoh

CosmosDBLocationList

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
BackupStorageRedundancy

Enum untuk menunjukkan jenis redundansi penyimpanan cadangan.

CloudError

Respons kesalahan dari layanan.

ErrorResponse

Respons Kesalahan.

LocationGetResult

Lokasi Cosmos DB mendapatkan hasil

LocationListResult

Respons operasi Daftar, yang berisi lokasi Cosmos DB dan propertinya.

LocationProperties

Metadata lokasi Cosmos DB

Status

Enum untuk menunjukkan status buildout wilayah saat ini.

BackupStorageRedundancy

Enum untuk menunjukkan jenis redundansi penyimpanan cadangan.

Nama Jenis Deskripsi
Geo

string

Local

string

Zone

string

CloudError

Respons kesalahan dari layanan.

Nama Jenis Deskripsi
error

ErrorResponse

Respons Kesalahan.

ErrorResponse

Respons Kesalahan.

Nama Jenis Deskripsi
code

string

Kode Kesalahan.

message

string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

LocationGetResult

Lokasi Cosmos DB mendapatkan hasil

Nama Jenis Deskripsi
id

string

Pengidentifikasi sumber daya unik akun database.

name

string

Nama akun database.

properties

LocationProperties

Metadata lokasi Cosmos DB

type

string

Jenis sumber daya Azure.

LocationListResult

Respons operasi Daftar, yang berisi lokasi Cosmos DB dan propertinya.

Nama Jenis Deskripsi
value

LocationGetResult[]

Daftar lokasi Cosmos DB dan propertinya.

LocationProperties

Metadata lokasi Cosmos DB

Nama Jenis Deskripsi
backupStorageRedundancies

BackupStorageRedundancy[]

Properti redundansi penyimpanan cadangan yang tersedia.

isResidencyRestricted

boolean

Bendera yang menunjukkan apakah lokasi sensitif terhadap residensi.

isSubscriptionRegionAccessAllowedForAz

boolean

Bendera yang menunjukkan apakah langganan memiliki akses di wilayah untuk Zona Ketersediaan (Az).

isSubscriptionRegionAccessAllowedForRegular

boolean

Bendera yang menunjukkan apakah langganan memiliki akses di wilayah untuk Zona Non-Ketersediaan.

status

Status

Enum untuk menunjukkan status buildout wilayah saat ini.

supportsAvailabilityZone

boolean

Bendera yang menunjukkan apakah lokasi mendukung zona ketersediaan atau tidak.

Status

Enum untuk menunjukkan status buildout wilayah saat ini.

Nama Jenis Deskripsi
Deleting

string

Initializing

string

InternallyReady

string

Online

string

Uninitialized

string