Locations - List
Cosmos DB 위치 및 해당 속성 나열
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations?api-version=2023-11-15
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
대상 구독의 ID입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
작업이 성공적으로 완료되었습니다. |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
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"
}
}
]
}
정의
Name | Description |
---|---|
Backup |
백업 스토리지 중복성 유형을 나타내는 열거형입니다. |
Cloud |
서비스의 오류 응답입니다. |
Error |
오류 응답. |
Location |
Cosmos DB 위치 가져오기 결과 |
Location |
Cosmos DB 위치 및 해당 속성을 포함하는 목록 작업 응답입니다. |
Location |
Cosmos DB 위치 메타데이터 |
Status |
지역의 현재 빌드 상태 나타내는 열거형입니다. |
BackupStorageRedundancy
백업 스토리지 중복성 유형을 나타내는 열거형입니다.
Name | 형식 | Description |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
CloudError
서비스의 오류 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 응답. |
ErrorResponse
오류 응답.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드 |
message |
string |
작업이 실패한 이유를 나타내는 오류 메시지입니다. |
LocationGetResult
Cosmos DB 위치 가져오기 결과
Name | 형식 | Description |
---|---|---|
id |
string |
데이터베이스 계정의 고유 리소스 식별자입니다. |
name |
string |
데이터베이스 계정의 이름입니다. |
properties |
Cosmos DB 위치 메타데이터 |
|
type |
string |
Azure 리소스의 유형입니다. |
LocationListResult
Cosmos DB 위치 및 해당 속성을 포함하는 목록 작업 응답입니다.
Name | 형식 | Description |
---|---|---|
value |
Cosmos DB 위치 및 해당 속성 목록입니다. |
LocationProperties
Cosmos DB 위치 메타데이터
Name | 형식 | Description |
---|---|---|
backupStorageRedundancies |
사용 가능한 백업 스토리지 중복의 속성입니다. |
|
isResidencyRestricted |
boolean |
위치가 상주에 중요한지 여부를 나타내는 플래그입니다. |
isSubscriptionRegionAccessAllowedForAz |
boolean |
구독이 가용성 영역(Az)에 대한 지역에서 액세스할 수 있는지 여부를 나타내는 플래그입니다. |
isSubscriptionRegionAccessAllowedForRegular |
boolean |
구독이 비 가용성 영역 지역에 액세스할 수 있는지 여부를 나타내는 플래그입니다. |
status |
지역의 현재 빌드 상태 나타내는 열거형입니다. |
|
supportsAvailabilityZone |
boolean |
위치가 가용성 영역을 지원하는지 여부를 나타내는 플래그입니다. |
Status
지역의 현재 빌드 상태 나타내는 열거형입니다.
Name | 형식 | Description |
---|---|---|
Deleting |
string |
|
Initializing |
string |
|
InternallyReady |
string |
|
Online |
string |
|
Uninitialized |
string |