Database Accounts - Update
기존 Azure Cosmos DB 데이터베이스 계정의 속성을 업데이트합니다.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2024-11-15
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB 데이터베이스 계정 이름입니다. regex 패턴: |
resource
|
path | True |
string |
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다. |
subscription
|
path | True |
string |
대상 구독의 ID입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
요청 본문
Name | 형식 | Description |
---|---|---|
identity |
리소스의 ID입니다. |
|
location |
string |
리소스가 속한 리소스 그룹의 위치입니다. |
properties.analyticalStorageConfiguration |
분석 스토리지 관련 속성입니다. |
|
properties.apiProperties |
API 관련 속성입니다. 현재 MongoDB API에 대해서만 지원됩니다. |
|
properties.backupPolicy | BackupPolicy: |
계정에서 백업을 수행하는 정책을 나타내는 개체입니다. |
properties.capabilities |
계정에 대한 Cosmos DB 기능 목록 |
|
properties.capacity |
계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다. |
|
properties.connectorOffer |
Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. |
|
properties.consistencyPolicy |
Cosmos DB 계정에 대한 일관성 정책입니다. |
|
properties.cors |
Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. |
|
properties.customerManagedKeyStatus |
string |
계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다. |
properties.defaultIdentity |
string |
고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. |
properties.disableKeyBasedMetadataWriteAccess |
boolean |
계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 |
properties.disableLocalAuth |
boolean |
로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다. |
properties.enableAnalyticalStorage |
boolean |
스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. |
properties.enableAutomaticFailover |
boolean |
가동 중단으로 인해 지역을 사용할 수 없는 드문 경우에서 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)로 인해 계정에 대한 새 쓰기 지역이 생성되고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. |
properties.enableBurstCapacity |
boolean |
계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.enableCassandraConnector |
boolean |
Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. |
properties.enableFreeTier |
boolean |
무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. |
properties.enableMultipleWriteLocations |
boolean |
계정을 여러 위치에 쓸 수 있도록 설정 |
properties.enablePartitionMerge |
boolean |
계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.enablePerRegionPerPartitionAutoscale |
boolean |
계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.ipRules |
IpRules 목록입니다. |
|
properties.isVirtualNetworkFilterEnabled |
boolean |
Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. |
properties.keyVaultKeyUri |
string |
키 자격 증명 모음의 URI |
properties.locations |
Location[] |
Cosmos DB 계정에 대해 사용하도록 설정된 지리 복제 위치를 포함하는 배열입니다. |
properties.minimalTlsVersion |
허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다. |
|
properties.networkAclBypass |
방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. |
|
properties.networkAclBypassResourceIds |
string[] |
Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. |
properties.publicNetworkAccess |
공용 네트워크의 요청 허용 여부 |
|
properties.virtualNetworkRules |
Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. |
|
tags |
object |
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
데이터베이스 계정 업데이트 작업이 비동기적으로 완료됩니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
CosmosDBDatabaseAccountPatch
샘플 요청
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-11-15
{
"location": "westus",
"tags": {
"dept": "finance"
},
"identity": {
"type": "SystemAssigned,UserAssigned",
"userAssignedIdentities": {
"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
}
},
"properties": {
"ipRules": [
{
"ipAddressOrRange": "23.43.230.120"
},
{
"ipAddressOrRange": "110.12.240.0/12"
}
],
"isVirtualNetworkFilterEnabled": true,
"virtualNetworkRules": [
{
"id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
"ignoreMissingVNetServiceEndpoint": false
}
],
"consistencyPolicy": {
"defaultConsistencyLevel": "BoundedStaleness",
"maxIntervalInSeconds": 10,
"maxStalenessPrefix": 200
},
"defaultIdentity": "FirstPartyIdentity",
"enableFreeTier": false,
"enableAnalyticalStorage": true,
"enableBurstCapacity": true,
"enablePerRegionPerPartitionAutoscale": true,
"analyticalStorageConfiguration": {
"schemaType": "WellDefined"
},
"backupPolicy": {
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": 240,
"backupRetentionIntervalInHours": 720,
"backupStorageRedundancy": "Local"
}
},
"networkAclBypass": "AzureServices",
"networkAclBypassResourceIds": [
"/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
],
"capacity": {
"totalThroughputLimit": 2000
},
"enablePartitionMerge": true,
"minimalTlsVersion": "Tls"
}
}
샘플 응답
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
"name": "ddb1",
"location": "West US",
"type": "Microsoft.DocumentDB/databaseAccounts",
"kind": "GlobalDocumentDB",
"tags": {
"dept": "finance"
},
"identity": {
"type": "SystemAssigned,UserAssigned",
"principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
"tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
"userAssignedIdentities": {
"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
"clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
"principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
}
}
},
"properties": {
"provisioningState": "Succeeded",
"documentEndpoint": "https://ddb1.documents.azure.com:443/",
"databaseAccountOfferType": "Standard",
"ipRules": [
{
"ipAddressOrRange": "23.43.230.120"
},
{
"ipAddressOrRange": "110.12.240.0/12"
}
],
"isVirtualNetworkFilterEnabled": true,
"disableKeyBasedMetadataWriteAccess": false,
"consistencyPolicy": {
"defaultConsistencyLevel": "BoundedStaleness",
"maxIntervalInSeconds": 10,
"maxStalenessPrefix": 200
},
"writeLocations": [
{
"id": "ddb1-eastus",
"locationName": "East US",
"documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
"provisioningState": "Succeeded",
"failoverPriority": 0
}
],
"readLocations": [
{
"id": "ddb1-eastus",
"locationName": "East US",
"documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
"provisioningState": "Succeeded",
"failoverPriority": 0
}
],
"locations": [
{
"id": "ddb1-eastus",
"locationName": "East US",
"documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
"provisioningState": "Succeeded",
"failoverPriority": 0
}
],
"failoverPolicies": [
{
"id": "ddb1-eastus",
"locationName": "East US",
"failoverPriority": 0
}
],
"virtualNetworkRules": [
{
"id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
"ignoreMissingVNetServiceEndpoint": false
}
],
"privateEndpointConnections": [
{
"id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"actionsRequired": "None"
}
}
}
],
"cors": [],
"defaultIdentity": "FirstPartyIdentity",
"enableFreeTier": false,
"apiProperties": {},
"enableAnalyticalStorage": true,
"enableBurstCapacity": true,
"analyticalStorageConfiguration": {
"schemaType": "WellDefined"
},
"backupPolicy": {
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": 240,
"backupRetentionIntervalInHours": 720,
"backupStorageRedundancy": "Local"
}
},
"networkAclBypass": "AzureServices",
"networkAclBypassResourceIds": [
"/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
],
"capacity": {
"totalThroughputLimit": 2000
},
"keysMetadata": {
"primaryMasterKey": {
"generationTime": "2022-02-25T20:30:11Z"
},
"secondaryMasterKey": {
"generationTime": "2022-02-25T20:30:11Z"
},
"primaryReadonlyMasterKey": {
"generationTime": "2022-02-25T20:30:11Z"
},
"secondaryReadonlyMasterKey": {
"generationTime": "2022-02-25T20:30:11Z"
}
},
"enablePartitionMerge": true,
"minimalTlsVersion": "Tls"
}
}
정의
Name | Description |
---|---|
Account |
지정된 데이터베이스 계정에 대한 액세스 키와 관련된 메타데이터입니다. |
Analytical |
분석 스토리지 관련 속성입니다. |
Analytical |
분석 스토리지에 대한 스키마 유형에 대해 설명합니다. |
Api |
|
Backup |
백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다. |
Backup |
백업 정책 유형 간의 마이그레이션 상태를 설명합니다. |
Backup |
백업 모드를 설명합니다. |
Backup |
백업 스토리지 중복의 유형을 나타내는 열거형입니다. |
Capability |
Cosmos DB 기능 개체 |
Capacity |
계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다. |
Connector |
Cosmos DB C* 데이터베이스 계정에 대한 cassandra 커넥터 제품 유형입니다. |
Consistency |
Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다. |
Continuous |
연속 모드 백업 정책을 나타내는 개체입니다. |
Continuous |
정기 모드 백업에 대한 구성 값 |
Continuous |
연속 백업 계층의 유형을 나타내는 열거형입니다. |
Cors |
Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. |
created |
리소스를 만든 ID의 형식입니다. |
Create |
계정 생성 모드를 나타내는 열거형입니다. |
Database |
Azure Cosmos DB 데이터베이스 계정. |
Database |
지정된 Cosmos DB 데이터베이스 계정에 대한 각 액세스 키와 관련된 메타데이터입니다. |
Database |
데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다. |
Database |
Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다. |
Database |
Azure Cosmos DB 데이터베이스 계정 속성을 패치하기 위한 매개 변수입니다. |
Database |
복원할 특정 데이터베이스입니다. |
Default |
Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다. |
Failover |
데이터베이스 계정의 지정된 지역에 대한 장애 조치(failover) 정책입니다. |
Gremlin |
복원할 특정 Gremlin 데이터베이스입니다. |
Ip |
IpAddressOrRange 개체 |
Location |
Azure Cosmos DB 데이터베이스 계정이 배포되는 지역입니다. |
Managed |
리소스의 ID입니다. |
Minimal |
허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다. |
Network |
방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. |
Periodic |
주기 모드 백업 정책을 나타내는 개체입니다. |
Periodic |
정기 모드 백업에 대한 구성 값 |
Private |
프라이빗 엔드포인트 연결 |
Private |
연결이 속한 프라이빗 엔드포인트입니다. |
Private |
프라이빗 엔드포인트 연결의 연결 상태입니다. |
Public |
공용 네트워크의 요청 허용 여부 |
Resource |
리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다. |
Restore |
복원 모드를 설명합니다. |
Restore |
복원에 대한 정보를 나타내는 매개 변수입니다. |
Server |
MongoDB 계정의 버전을 설명합니다. |
system |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
User |
리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. |
Virtual |
Virtual Network ACL 규칙 개체 |
AccountKeyMetadata
지정된 데이터베이스 계정에 대한 액세스 키와 관련된 메타데이터입니다.
Name | 형식 | Description |
---|---|---|
generationTime |
string |
키의 UTC 생성 시간(ISO-8601 형식)입니다. 개체에서 값이 누락된 경우 2022-06-18 이전에 마지막 키 다시 생성이 트리거되었음을 의미합니다. |
AnalyticalStorageConfiguration
분석 스토리지 관련 속성입니다.
Name | 형식 | Description |
---|---|---|
schemaType |
분석 스토리지에 대한 스키마 유형에 대해 설명합니다. |
AnalyticalStorageSchemaType
분석 스토리지에 대한 스키마 유형에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
FullFidelity |
string |
|
WellDefined |
string |
ApiProperties
Name | 형식 | Description |
---|---|---|
serverVersion |
MongoDB 계정의 버전을 설명합니다. |
BackupPolicyMigrationState
백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
startTime |
string |
백업 정책 마이그레이션이 시작된 시간(ISO-8601 형식). |
status |
백업 정책 유형 간의 마이그레이션 상태를 설명합니다. |
|
targetType |
백업 정책 마이그레이션의 대상 백업 정책 유형을 설명합니다. |
BackupPolicyMigrationStatus
백업 정책 유형 간의 마이그레이션 상태를 설명합니다.
Name | 형식 | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
|
Invalid |
string |
BackupPolicyType
백업 모드를 설명합니다.
Name | 형식 | Description |
---|---|---|
Continuous |
string |
|
Periodic |
string |
BackupStorageRedundancy
백업 스토리지 중복의 유형을 나타내는 열거형입니다.
Name | 형식 | Description |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
Capability
Cosmos DB 기능 개체
Name | 형식 | Description |
---|---|---|
name |
string |
Cosmos DB 기능의 이름입니다. 예를 들어 "name": "EnableCassandra"입니다. 현재 값에는 "EnableTable" 및 "EnableGremlin"도 포함됩니다. |
Capacity
계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
totalThroughputLimit |
integer |
계정에 적용되는 총 처리량 제한입니다. totalThroughputLimit 2000은 해당 계정에 프로비전할 수 있는 최대 처리량의 엄격한 제한을 2000으로 적용합니다. -1 totalThroughputLimit는 처리량 프로비저닝에 제한이 없음을 나타냅니다. |
ConnectorOffer
Cosmos DB C* 데이터베이스 계정에 대한 cassandra 커넥터 제품 유형입니다.
Name | 형식 | Description |
---|---|---|
Small |
string |
ConsistencyPolicy
Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다.
Name | 형식 | Description |
---|---|---|
defaultConsistencyLevel |
Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다. |
|
maxIntervalInSeconds |
integer |
제한된 부실 일관성 수준과 함께 사용하는 경우 이 값은 허용되는 부실 시간(초)을 나타냅니다. 이 값에 허용되는 범위는 5 - 86400입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. |
maxStalenessPrefix |
integer |
제한된 부실 일관성 수준과 함께 사용하는 경우 이 값은 허용되는 부실 요청 수를 나타냅니다. 이 값에 허용되는 범위는 1 – 2,147,483,647입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. |
ContinuousModeBackupPolicy
연속 모드 백업 정책을 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
continuousModeProperties |
연속 모드 백업에 대한 구성 값 |
|
migrationState |
백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다. |
|
type |
string:
Continuous |
백업 모드를 설명합니다. |
ContinuousModeProperties
정기 모드 백업에 대한 구성 값
Name | 형식 | Description |
---|---|---|
tier |
연속 백업 모드 유형을 나타내는 열거형 |
ContinuousTier
연속 백업 계층의 유형을 나타내는 열거형입니다.
Name | 형식 | Description |
---|---|---|
Continuous30Days |
string |
|
Continuous7Days |
string |
CorsPolicy
Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다.
Name | 형식 | Description |
---|---|---|
allowedHeaders |
string |
원본 도메인이 CORS 요청에 지정할 수 있는 요청 헤더입니다. |
allowedMethods |
string |
원본 도메인이 CORS 요청에 사용할 수 있는 메서드(HTTP 요청 동사)입니다. |
allowedOrigins |
string |
CORS를 통해 서비스에 대한 요청을 할 수 있는 원본 도메인입니다. |
exposedHeaders |
string |
CORS 요청에 대한 응답으로 전송되고 브라우저에서 요청 발급자에게 노출될 수 있는 응답 헤더입니다. |
maxAgeInSeconds |
integer |
브라우저에서 실행 전 OPTIONS 요청을 캐시해야 하는 최대 시간입니다. |
createdByType
리소스를 만든 ID의 형식입니다.
Name | 형식 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
계정 생성 모드를 나타내는 열거형입니다.
Name | 형식 | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DatabaseAccountGetResults
Azure Cosmos DB 데이터베이스 계정.
Name | 형식 | Default value | Description |
---|---|---|---|
id |
string |
ARM 리소스의 고유 리소스 식별자입니다. |
|
identity |
리소스의 ID입니다. |
||
kind | GlobalDocumentDB |
데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다. |
|
location |
string |
리소스가 속한 리소스 그룹의 위치입니다. |
|
name |
string |
ARM 리소스의 이름입니다. |
|
properties.analyticalStorageConfiguration |
분석 스토리지 관련 속성입니다. |
||
properties.apiProperties |
API 관련 속성입니다. |
||
properties.backupPolicy | BackupPolicy: |
계정에서 백업을 수행하는 정책을 나타내는 개체입니다. |
|
properties.capabilities |
계정에 대한 Cosmos DB 기능 목록 |
||
properties.capacity |
계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다. |
||
properties.connectorOffer |
Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. |
||
properties.consistencyPolicy |
Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다. |
||
properties.cors |
Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. |
||
properties.createMode | Default |
계정 생성 모드를 나타내는 열거형입니다. |
|
properties.customerManagedKeyStatus |
string |
계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다. |
|
properties.databaseAccountOfferType |
Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다. 기본값: Standard. |
||
properties.defaultIdentity |
string |
고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. |
|
properties.disableKeyBasedMetadataWriteAccess |
boolean |
계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 |
|
properties.disableLocalAuth |
boolean |
로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다. |
|
properties.documentEndpoint |
string |
Cosmos DB 데이터베이스 계정에 대한 연결 엔드포인트입니다. |
|
properties.enableAnalyticalStorage |
boolean |
스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. |
|
properties.enableAutomaticFailover |
boolean |
가동 중단으로 인해 지역을 사용할 수 없는 드문 경우에서 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)로 인해 계정에 대한 새 쓰기 지역이 생성되고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. |
|
properties.enableBurstCapacity |
boolean |
계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그 |
|
properties.enableCassandraConnector |
boolean |
Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. |
|
properties.enableFreeTier |
boolean |
무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. |
|
properties.enableMultipleWriteLocations |
boolean |
계정을 여러 위치에 쓸 수 있도록 설정 |
|
properties.enablePartitionMerge |
boolean |
계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그 |
|
properties.enablePerRegionPerPartitionAutoscale |
boolean |
계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그 |
|
properties.failoverPolicies |
장애 조치(failover) 우선 순위에 따라 정렬된 지역을 포함하는 배열입니다. |
||
properties.instanceId |
string |
데이터베이스 계정에 할당된 고유 식별자 |
|
properties.ipRules |
IpRules 목록입니다. |
||
properties.isVirtualNetworkFilterEnabled |
boolean |
Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. |
|
properties.keyVaultKeyUri |
string |
키 자격 증명 모음의 URI |
|
properties.keysMetadata |
Cosmos DB 계정의 계정 키에 대한 메타데이터를 나타내는 개체입니다. |
||
properties.locations |
Location[] |
Cosmos DB 계정에 대해 사용하도록 설정된 모든 위치를 포함하는 배열입니다. |
|
properties.minimalTlsVersion |
허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다. |
||
properties.networkAclBypass |
방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. |
||
properties.networkAclBypassResourceIds |
string[] |
Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. |
|
properties.privateEndpointConnections |
Cosmos DB 계정에 대해 구성된 프라이빗 엔드포인트 연결 목록입니다. |
||
properties.provisioningState |
string |
작업이 호출된 당시 Cosmos DB 계정의 상태입니다. 상태는 다음 중 하나일 수 있습니다. '만들기' – Cosmos DB 계정이 만들어지고 있습니다. 계정이 만들기 상태인 경우 Cosmos DB 계정 만들기 작업에 대한 입력으로 지정된 속성만 반환됩니다. '성공' – Cosmos DB 계정이 활성화되어 있습니다. '업데이트' – Cosmos DB 계정이 업데이트되고 있습니다. '삭제 중' – Cosmos DB 계정이 삭제되고 있습니다. '실패' – Cosmos DB 계정을 만들지 못했습니다. 'DeletionFailed' – Cosmos DB 계정 삭제에 실패했습니다. |
|
properties.publicNetworkAccess |
공용 네트워크의 요청 허용 여부 |
||
properties.readLocations |
Location[] |
Cosmos DB 계정에 대해 사용하도록 설정된 읽기 위치가 포함된 배열입니다. |
|
properties.restoreParameters |
복원에 대한 정보를 나타내는 매개 변수입니다. |
||
properties.virtualNetworkRules |
Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. |
||
properties.writeLocations |
Location[] |
Cosmos DB 계정에 대한 쓰기 위치를 포함하는 배열입니다. |
|
systemData |
이 리소스와 관련된 시스템 메타 데이터입니다. |
||
tags |
object |
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. |
|
type |
string |
Azure 리소스의 유형입니다. |
DatabaseAccountKeysMetadata
지정된 Cosmos DB 데이터베이스 계정에 대한 각 액세스 키와 관련된 메타데이터입니다.
Name | 형식 | Description |
---|---|---|
primaryMasterKey |
지정된 Cosmos DB 데이터베이스 계정에 대한 기본 Read-Write 키와 관련된 메타데이터입니다. |
|
primaryReadonlyMasterKey |
지정된 Cosmos DB 데이터베이스 계정에 대한 기본 Read-Only 키와 관련된 메타데이터입니다. |
|
secondaryMasterKey |
지정된 Cosmos DB 데이터베이스 계정에 대한 보조 Read-Write 키와 관련된 메타데이터입니다. |
|
secondaryReadonlyMasterKey |
지정된 Cosmos DB 데이터베이스 계정에 대한 보조 Read-Only 키와 관련된 메타데이터입니다. |
DatabaseAccountKind
데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다.
Name | 형식 | Description |
---|---|---|
GlobalDocumentDB |
string |
|
MongoDB |
string |
|
Parse |
string |
DatabaseAccountOfferType
Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다.
Name | 형식 | Description |
---|---|---|
Standard |
string |
DatabaseAccountUpdateParameters
Azure Cosmos DB 데이터베이스 계정 속성을 패치하기 위한 매개 변수입니다.
Name | 형식 | Description |
---|---|---|
identity |
리소스의 ID입니다. |
|
location |
string |
리소스가 속한 리소스 그룹의 위치입니다. |
properties.analyticalStorageConfiguration |
분석 스토리지 관련 속성입니다. |
|
properties.apiProperties |
API 관련 속성입니다. 현재 MongoDB API에 대해서만 지원됩니다. |
|
properties.backupPolicy | BackupPolicy: |
계정에서 백업을 수행하는 정책을 나타내는 개체입니다. |
properties.capabilities |
계정에 대한 Cosmos DB 기능 목록 |
|
properties.capacity |
계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다. |
|
properties.connectorOffer |
Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. |
|
properties.consistencyPolicy |
Cosmos DB 계정에 대한 일관성 정책입니다. |
|
properties.cors |
Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. |
|
properties.customerManagedKeyStatus |
string |
계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다. |
properties.defaultIdentity |
string |
고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. |
properties.disableKeyBasedMetadataWriteAccess |
boolean |
계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 |
properties.disableLocalAuth |
boolean |
로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다. |
properties.enableAnalyticalStorage |
boolean |
스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. |
properties.enableAutomaticFailover |
boolean |
가동 중단으로 인해 지역을 사용할 수 없는 드문 경우에서 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)로 인해 계정에 대한 새 쓰기 지역이 생성되고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. |
properties.enableBurstCapacity |
boolean |
계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.enableCassandraConnector |
boolean |
Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. |
properties.enableFreeTier |
boolean |
무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. |
properties.enableMultipleWriteLocations |
boolean |
계정을 여러 위치에 쓸 수 있도록 설정 |
properties.enablePartitionMerge |
boolean |
계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.enablePerRegionPerPartitionAutoscale |
boolean |
계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그 |
properties.ipRules |
IpRules 목록입니다. |
|
properties.isVirtualNetworkFilterEnabled |
boolean |
Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. |
properties.keyVaultKeyUri |
string |
키 자격 증명 모음의 URI |
properties.keysMetadata |
메타데이터가 읽기 전용이므로 이 속성은 업데이트 작업 중에 무시됩니다. 개체는 Cosmos DB 계정의 계정 키에 대한 메타데이터를 나타냅니다. |
|
properties.locations |
Location[] |
Cosmos DB 계정에 대해 사용하도록 설정된 지리 복제 위치를 포함하는 배열입니다. |
properties.minimalTlsVersion |
허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다. |
|
properties.networkAclBypass |
방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. |
|
properties.networkAclBypassResourceIds |
string[] |
Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. |
properties.publicNetworkAccess |
공용 네트워크의 요청 허용 여부 |
|
properties.virtualNetworkRules |
Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. |
|
tags |
object |
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. |
DatabaseRestoreResource
복원할 특정 데이터베이스입니다.
Name | 형식 | Description |
---|---|---|
collectionNames |
string[] |
복원에 사용할 수 있는 컬렉션의 이름입니다. |
databaseName |
string |
복원에 사용할 수 있는 데이터베이스의 이름입니다. |
DefaultConsistencyLevel
Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다.
Name | 형식 | Description |
---|---|---|
BoundedStaleness |
string |
|
ConsistentPrefix |
string |
|
Eventual |
string |
|
Session |
string |
|
Strong |
string |
FailoverPolicy
데이터베이스 계정의 지정된 지역에 대한 장애 조치(failover) 정책입니다.
Name | 형식 | Description |
---|---|---|
failoverPriority |
integer |
지역의 장애 조치(failover) 우선 순위입니다. 장애 조치(failover) 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다. |
id |
string |
데이터베이스 계정이 복제되는 지역의 고유 식별자입니다. 예: <accountName>- locationName><. |
locationName |
string |
데이터베이스 계정이 있는 지역의 이름입니다. |
GremlinDatabaseRestoreResource
복원할 특정 Gremlin 데이터베이스입니다.
Name | 형식 | Description |
---|---|---|
databaseName |
string |
복원에 사용할 수 있는 gremlin 데이터베이스의 이름입니다. |
graphNames |
string[] |
복원에 사용할 수 있는 그래프의 이름입니다. |
IpAddressOrRange
IpAddressOrRange 개체
Name | 형식 | Description |
---|---|---|
ipAddressOrRange |
string |
단일 IPv4 주소 또는 CIDR 형식의 단일 IPv4 주소 범위입니다. 제공된 IP는 형식이 잘 지정되어야 하며 다음 범위 중 하나에 포함될 수 없습니다. 10.0.0.0/8, IP 주소 필터에서 적용할 수 없으므로 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16. 유효한 입력의 예: "23.40.210.245" 또는 "23.40.210.0/8". |
Location
Azure Cosmos DB 데이터베이스 계정이 배포되는 지역입니다.
Name | 형식 | Description |
---|---|---|
documentEndpoint |
string |
특정 지역에 대한 연결 엔드포인트입니다. 예: https://<accountName>-<locationName>.documents.azure.com:443/ |
failoverPriority |
integer |
지역의 장애 조치(failover) 우선 순위입니다. 장애 조치(failover) 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다. |
id |
string |
데이터베이스 계정 내 지역의 고유 식별자입니다. 예: <accountName>- locationName><. |
isZoneRedundant |
boolean |
이 지역이 AvailabilityZone 지역인지 여부를 나타내는 플래그 |
locationName |
string |
지역 이름입니다. |
provisioningState |
string |
작업이 호출된 당시 Cosmos DB 계정의 상태입니다. 상태는 다음 중 하나일 수 있습니다. '만들기' – Cosmos DB 계정이 만들어지고 있습니다. 계정이 만들기 상태인 경우 Cosmos DB 계정 만들기 작업에 대한 입력으로 지정된 속성만 반환됩니다. '성공' – Cosmos DB 계정이 활성화되어 있습니다. '업데이트' – Cosmos DB 계정이 업데이트되고 있습니다. '삭제 중' – Cosmos DB 계정이 삭제되고 있습니다. '실패' – Cosmos DB 계정을 만들지 못했습니다. 'DeletionFailed' – Cosmos DB 계정 삭제에 실패했습니다. |
ManagedServiceIdentity
리소스의 ID입니다.
Name | 형식 | Description |
---|---|---|
principalId |
string |
시스템 할당 ID의 보안 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다. |
tenantId |
string |
시스템 할당 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다. |
type |
리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다. |
|
userAssignedIdentities |
리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. |
MinimalTlsVersion
허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.
Name | 형식 | Description |
---|---|---|
Tls |
string |
|
Tls11 |
string |
|
Tls12 |
string |
NetworkAclBypass
방화벽 검사를 무시할 수 있는 서비스를 나타냅니다.
Name | 형식 | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
PeriodicModeBackupPolicy
주기 모드 백업 정책을 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
migrationState |
백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다. |
|
periodicModeProperties |
정기 모드 백업에 대한 구성 값 |
|
type |
string:
Periodic |
백업 모드를 설명합니다. |
PeriodicModeProperties
정기 모드 백업에 대한 구성 값
Name | 형식 | Description |
---|---|---|
backupIntervalInMinutes |
integer |
두 백업 사이의 간격(분)을 나타내는 정수입니다. |
backupRetentionIntervalInHours |
integer |
각 백업이 보존되는 시간(시간)을 나타내는 정수입니다. |
backupStorageRedundancy |
백업 상주 유형을 나타내는 열거형 |
PrivateEndpointConnection
프라이빗 엔드포인트 연결
Name | 형식 | Description |
---|---|---|
id |
string |
리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
리소스의 이름 |
properties.groupId |
string |
프라이빗 엔드포인트의 그룹 ID입니다. |
properties.privateEndpoint |
연결이 속한 프라이빗 엔드포인트입니다. |
|
properties.privateLinkServiceConnectionState |
프라이빗 엔드포인트 연결의 연결 상태입니다. |
|
properties.provisioningState |
string |
프라이빗 엔드포인트의 프로비전 상태입니다. |
type |
string |
리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" |
PrivateEndpointProperty
연결이 속한 프라이빗 엔드포인트입니다.
Name | 형식 | Description |
---|---|---|
id |
string |
프라이빗 엔드포인트의 리소스 ID입니다. |
PrivateLinkServiceConnectionStateProperty
프라이빗 엔드포인트 연결의 연결 상태입니다.
Name | 형식 | Description |
---|---|---|
actionsRequired |
string |
기본 워크플로를 넘어서 필요한 모든 작업(승인/거부/연결 끊기) |
description |
string |
프라이빗 링크 서비스 연결 설명입니다. |
status |
string |
프라이빗 링크 서비스 연결 상태입니다. |
PublicNetworkAccess
공용 네트워크의 요청 허용 여부
Name | 형식 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
ResourceIdentityType
리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.
Name | 형식 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
RestoreMode
복원 모드를 설명합니다.
Name | 형식 | Description |
---|---|---|
PointInTime |
string |
RestoreParameters
복원에 대한 정보를 나타내는 매개 변수입니다.
Name | 형식 | Description |
---|---|---|
databasesToRestore |
복원에 사용할 수 있는 특정 데이터베이스 목록입니다. |
|
gremlinDatabasesToRestore |
복원에 사용할 수 있는 특정 gremlin 데이터베이스 목록입니다. |
|
restoreMode |
복원 모드를 설명합니다. |
|
restoreSource |
string |
복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
계정을 복원해야 하는 시간(ISO-8601 형식)입니다. |
restoreWithTtlDisabled |
boolean |
복원이 성공하면 복원된 계정에 Time-To-Live 사용하지 않도록 설정할지 여부를 지정합니다. |
tablesToRestore |
string[] |
복원에 사용할 수 있는 특정 테이블 목록입니다. |
ServerVersion
MongoDB 계정의 버전을 설명합니다.
Name | 형식 | Description |
---|---|---|
3.2 |
string |
|
3.6 |
string |
|
4.0 |
string |
|
4.2 |
string |
|
5.0 |
string |
|
6.0 |
string |
|
7.0 |
string |
systemData
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
Name | 형식 | Description |
---|---|---|
createdAt |
string |
리소스 만들기의 타임스탬프(UTC)입니다. |
createdBy |
string |
리소스를 만든 ID입니다. |
createdByType |
리소스를 만든 ID의 형식입니다. |
|
lastModifiedAt |
string |
리소스 마지막 수정의 타임스탬프(UTC) |
lastModifiedBy |
string |
리소스를 마지막으로 수정한 ID입니다. |
lastModifiedByType |
리소스를 마지막으로 수정한 ID의 형식입니다. |
UserAssignedIdentities
리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.
Name | 형식 | Description |
---|---|---|
|
VirtualNetworkRule
Virtual Network ACL 규칙 개체
Name | 형식 | Description |
---|---|---|
id |
string |
서브넷의 리소스 ID(예: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}). |
ignoreMissingVNetServiceEndpoint |
boolean |
가상 네트워크에 vnet 서비스 엔드포인트를 사용하도록 설정하기 전에 방화벽 규칙을 만듭니다. |