Microsoft.DocumentDB databaseAccounts 2021-04-01-preview
- 최신
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-미리 보기
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Bicep 리소스 정의
databaseAccounts 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.
리소스 형식
Microsoft.DocumentDB/databaseAccounts 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
connectorOffer: 'Small'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
disableKeyBasedMetadataWriteAccess: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
createMode: 'string'
// For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
}
}
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties 개체
createMode 속성을 설정하여 개체 유형을 지정합니다.
기본값의 경우 다음을 사용합니다.
createMode: 'Default'
복원의 경우 다음을 사용합니다.
createMode: 'Restore'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
restoreMode: 'PointInTime'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
BackupPolicy 개체
형식 속성을 설정하여 개체의 형식을 지정합니다.
연속의 경우 다음을 사용합니다.
type: 'Continuous'
주기적인 경우 다음을 사용합니다.
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
속성 값
databaseAccounts
| Name | Description | 값 |
|---|---|---|
| name | 리소스 이름 | string(필수) 문자 제한: 3-44 유효한 문자: 소문자, 숫자 및 하이픈 소문자 또는 숫자로 시작합니다. 리소스 이름은 Azure에서 고유해야 합니다. |
| 위치 | 리소스가 속한 리소스 그룹의 위치입니다. | string |
| tags | 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. | 태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요. |
| kind | 데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다. | 'GlobalDocumentDB' 'MongoDB' '구문 분석' |
| identity | 리소스의 ID입니다. | ManagedServiceIdentity |
| properties | Azure Cosmos DB 데이터베이스 계정을 만들고 업데이트하는 속성입니다. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (필수) |
ManagedServiceIdentity
| Name | Description | 값 |
|---|---|---|
| 형식 | 리소스에 사용되는 ID 유형입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | 값 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Description | 값 |
|---|---|---|
| apiProperties | API 관련 속성입니다. 현재 MongoDB API에 대해서만 지원됩니다. | ApiProperties |
| backupPolicy | 계정에서 백업을 수행하는 정책을 나타내는 개체입니다. | BackupPolicy |
| capabilities | 계정에 대한 Cosmos DB 기능 목록 | Capability[] |
| connectorOffer | Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. | 'Small' |
| consistencyPolicy | Cosmos DB 계정에 대한 일관성 정책입니다. | ConsistencyPolicy |
| cors | Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. | CorsPolicy[] |
| databaseAccountOfferType | 데이터베이스에 대한 제품 유형 | 'Standard'(필수) |
| defaultIdentity | 고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. | string |
| disableKeyBasedMetadataWriteAccess | 계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 | bool |
| enableAnalyticalStorage | 스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| enableAutomaticFailover | 가동 중단으로 인해 지역을 사용할 수 없는 드문 경우 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)는 계정에 대한 새 쓰기 지역을 생성하고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. | bool |
| enableCassandraConnector | Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. | bool |
| enableFreeTier | 무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. | bool |
| enableMultipleWriteLocations | 계정이 여러 위치에 쓸 수 있도록 합니다. | bool |
| ipRules | IpRules 목록입니다. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| keyVaultKeyUri | 키 자격 증명 모음의 URI | string |
| 위치 | Cosmos DB 계정에 대해 사용하도록 설정된 지리 복제 위치를 포함하는 배열입니다. | Location[] (필수) |
| networkAclBypass | 방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. | 'AzureServices' 'None' |
| networkAclBypassResourceIds | Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. | string[] |
| publicNetworkAccess | 공용 네트워크의 요청 허용 여부 | 'Disabled' 'Enabled' |
| virtualNetworkRules | Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. | VirtualNetworkRule[] |
| createMode | 개체 유형 설정 | 기본값 복원 (필수) |
ApiProperties
| Name | Description | 값 |
|---|---|---|
| serverVersion | MongoDB 계정의 ServerVersion에 대해 설명합니다. | '3.2' '3.6' '4.0' |
BackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 개체 형식 설정 | 연속 주기적 (필수) |
ContinuousModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | 'Continuous'(필수) |
PeriodicModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | '주기적'(필수) |
| periodicModeProperties | 주기적 모드 백업에 대한 구성 값 | PeriodicModeProperties |
PeriodicModeProperties
| Name | Description | 값 |
|---|---|---|
| backupIntervalInMinutes | 두 백업 사이의 간격(분)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupRetentionIntervalInHours | 각 백업이 보존되는 시간(시간)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupStorageRedundancy | 백업 상주 유형을 나타내는 열거형 | 'Geo' '로컬' 'Zone' |
기능
| Name | Description | 값 |
|---|---|---|
| name | Cosmos DB 기능의 이름입니다. 예를 들어 "name": "EnableCassandra"입니다. 현재 값에는 "EnableTable" 및 "EnableGremlin"도 포함됩니다. | string |
ConsistencyPolicy
| Name | Description | 값 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다. | 'BoundedStaleness' 'ConsistentPrefix' '최종' '세션' 'Strong'(필수) |
| maxIntervalInSeconds | 제한된 부실 일관성 수준과 함께 사용할 경우 이 값은 허용되는 부실 시간(초)을 나타냅니다. 이 값에 허용되는 범위는 5 - 86400입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 5 최대값 = 86400 |
| maxStalenessPrefix | 제한된 부실 일관성 수준과 함께 사용할 경우 이 값은 허용되는 부실 요청 수를 나타냅니다. 이 값의 허용 범위는 1-2,147,483,647입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
CorsPolicy
| Name | Description | 값 |
|---|---|---|
| allowedHeaders | 원본 도메인이 CORS 요청에 대해 지정할 수 있는 요청 헤더입니다. | 문자열 |
| allowedMethods | 원본 도메인이 CORS 요청에 사용할 수 있는 메서드(HTTP 요청 동사)입니다. | string |
| allowedOrigins | CORS를 통해 서비스에 대한 요청을 할 수 있는 원본 도메인입니다. | string(필수) |
| exposedHeaders | CORS 요청에 대한 응답에 포함하여 전송할 수 있으며 브라우저에서 요청 발급자에게 표시할 수 있는 응답 헤더입니다. | 문자열 |
| maxAgeInSeconds | 브라우저가 실행 전 OPTIONS 요청을 캐시해야 하는 최대 시간입니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
IpAddressOrRange
| Name | Description | 값 |
|---|---|---|
| ipAddressOrRange | 단일 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". | 문자열 |
위치
| 이름 | Description | 값 |
|---|---|---|
| failoverPriority | 지역의 장애 조치(failover) 우선 순위입니다. 장애 조치 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치(failover) 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다. | int 제약 조건: 최소값 = 0 |
| isZoneRedundant | 이 지역이 AvailabilityZone 지역인지 여부를 나타내는 플래그 | bool |
| locationName | 영역의 이름입니다. | string |
VirtualNetworkRule
| Name | Description | 값 |
|---|---|---|
| id | 서브넷의 리소스 ID(예: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}). | string |
| ignoreMissingVNetServiceEndpoint | 가상 네트워크에 vnet 서비스 엔드포인트를 사용하도록 설정하기 전에 방화벽 규칙을 만듭니다. | bool |
DefaultRequestDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | 'Default'(필수) |
RestoreReqeustDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | 'Restore'(필수) |
| restoreParameters | 복원에 대한 정보를 나타내는 매개 변수입니다. | RestoreParameters |
RestoreParameters
| Name | Description | 값 |
|---|---|---|
| databasesToRestore | 복원에 사용할 수 있는 특정 데이터베이스 목록입니다. | DatabaseRestoreResource[] |
| restoreMode | 복원 모드를 설명합니다. | 'PointInTime' |
| restoreSource | 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 문자열 |
| restoreTimestampInUtc | 계정을 복원해야 하는 시간(ISO-8601 형식). | 문자열 |
DatabaseRestoreResource
| Name | Description | 값 |
|---|---|---|
| collectionNames | 복원에 사용할 수 있는 컬렉션의 이름입니다. | string[] |
| databaseName | 복원에 사용할 수 있는 데이터베이스의 이름입니다. | string |
빠른 시작 템플릿
다음 빠른 시작 템플릿은 이 리소스 종류를 배포합니다.
| 템플릿 | Description |
|---|---|
AKS(Azure Container Service)에서 Jenkins를 사용하는 CI/CD |
컨테이너를 사용하면 애플리케이션을 지속적으로 빌드하고 배포할 수 있습니다. Azure Container Service에서 Kubernetes를 사용하여 해당 컨테이너의 배포를 오케스트레이션하면 복제 가능하고 관리 가능한 컨테이너 클러스터를 달성할 수 있습니다. 컨테이너 이미지 및 오케스트레이션을 생성하도록 연속 빌드를 설정하면 배포의 속도와 안정성을 높일 수 있습니다. |
| SQL Database, Azure Cosmos DB, Azure Search를 사용하는 웹앱 |
이 템플릿은 웹앱, SQL Database, Azure Cosmos DB, Azure Search 및 Application Insights를 프로비전합니다. |
| Cassandra API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 키스페이스와 전용 처리량이 있는 테이블이 있는 두 지역에 Cassandra API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Cassandra API에 대한 자동 크기 조정 Azure Cosmos DB 계정 만들기 |
이 템플릿은 자동 크기 조정 처리량이 있는 키스페이스와 테이블이 있는 두 지역에 Cassandra API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Azure CosmosDB 계정 만들기 |
이 ARM 템플릿은 필요한 최소한의 값으로 CosmosDB 계정을 신속하게 만들기 위한 것입니다. |
| 여러 지역에서 Azure Cosmos DB 계정 만들기 |
이 템플릿은 일관성 수준 및 장애 조치(failover) 유형을 선택한 기본 및 보조 지역이 있는 모든 데이터베이스 API 유형에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 무료 계층 Azure Cosmos DB 계정 만들기 |
이 템플릿은 공유 처리량 및 컨테이너가 있는 데이터베이스를 사용하여 SQL API에 대한 무료 계층 Azure Cosmos DB 계정을 만듭니다. |
| Gremlin API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 전용 처리량을 사용하여 하나의 데이터베이스와 하나의 그래프가 있는 두 지역에 Gremlin API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Gremlin API 자동 크기 조정에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 자동 크기 조정 처리량을 사용하여 하나의 데이터베이스와 하나의 그래프가 있는 두 지역에 Gremlin API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| MongoDB API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 두 개의 컬렉션이 있는 공유 및 전용 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다. |
| MongoDB API 자동 크기 조정에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 공유 및 전용 자동 크기 조정 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 프라이빗 엔드포인트를 사용하여 Azure Cosmos DB 계정 만들기 |
이 템플릿은 Cosmos 계정을 가상 네트워크에 노출하는 Cosmos 계정, 가상 네트워크 및 프라이빗 엔드포인트를 만듭니다. |
| Core(SQL) API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 다른 여러 옵션이 있는 처리량이 있는 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| 분석 저장소가 있는 Azure Cosmos DB 계정 SQL API |
이 템플릿은 분석 저장소로 구성된 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| 자동 크기 조정을 사용하여 Azure Cosmos DB 계정 SQL API 만들기 |
이 템플릿은 다른 여러 옵션이 있는 자동 크기 조정 처리량이 있는 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| Azure Cosmos DB Core(SQL) API 저장 프로시저 만들기 |
이 템플릿은 Core(SQL) API에 대한 Azure Cosmos DB 계정과 저장 프로시저, 트리거 및 사용자 정의 함수가 있는 컨테이너를 만듭니다. |
| Core(SQL) API에 대한 최소 Azure Cosmos DB 계정 만들기 |
이 템플릿은 필요한 최소한의 리소스 속성만 지정하면서 Core(SQL) API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| SQL API 및 여러 컨테이너를 사용하여 Azure Cosmos 만들기 |
템플릿은 SQL API를 사용하여 Cosmos 컨테이너를 만들고 mulitple 컨테이너를 추가할 수 있습니다. |
| 데이터 평면 RBAC를 사용하여 Azure Cosmos DB SQL 계정 만들기 |
이 템플릿은 SQL Cosmos 계정, 고유하게 유지 관리되는 역할 정의 및 AAD ID에 대해 고유하게 유지 관리되는 역할 할당을 만듭니다. |
| SQL API에 대한 서버리스 Azure Cosmos DB 계정 만들기 |
이 템플릿은 Core(SQL) API에 대한 서버리스 Azure Cosmos DB 계정을 만듭니다. |
| Table API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 프로비전된 처리량이 있는 단일 테이블과 두 지역의 Table API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 자동 크기 조정을 사용하여 Table API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 두 지역의 Table API에 대한 Azure Cosmos DB 계정과 자동 크기 조정 처리량이 있는 단일 테이블을 만듭니다. |
| 제로 터치 Azure Cosmos 계정 및 Azure Web App 만들기 |
이 템플릿은 Azure Cosmos 계정을 만들고, Cosmos DB 엔드포인트 및 키를 Azure Web App 설정에 삽입한 다음, GitHub에서 ASP MVC 웹앱을 배포합니다. |
| Microsoft Defender를 사용하도록 설정된 Cosmos DB 계정 만들기 |
이 ARM 템플릿을 사용하여 Azure Cosmos DB용 Microsoft Defender를 사용하도록 설정된 Azure Cosmos DB 계정을 배포할 수 있습니다. Azure Cosmos DB용 Microsoft Defender는 Azure Cosmos DB 계정의 데이터베이스를 악용하려는 모든 시도를 검색하는 Azure 네이티브 보안 계층입니다. Azure Cosmos DB용 Microsoft Defender는 잠재적인 SQL 삽입, Microsoft 위협 인텔리전스를 기반으로 알려진 악의적 행위자, 의심스러운 액세스 패턴 및 손상된 ID 또는 악의적인 내부자를 통해 데이터베이스의 잠재적 악용을 검색합니다. |
| Cosmos DB 연결을 사용하여 Azure Data Explorer DB 배포 |
Cosmos DB 연결을 사용하여 Azure Data Explorer DB를 배포합니다. |
| 웹앱을 사용하는 Azure Cosmos DB 계정 |
이 템플릿은 Azure Cosmos DB 계정, App Service 계획을 배포하고 App Service 계획에 웹앱을 만듭니다. 또한 Azure Cosmos DB 계정 엔드포인트를 참조하는 웹앱에 두 개의 애플리케이션 설정을 추가합니다. 이러한 방식으로 웹앱에 배포된 솔루션은 이러한 설정을 사용하여 Azure Cosmos DB 계정 엔드포인트에 연결할 수 있습니다. |
ARM 템플릿 리소스 정의
databaseAccounts 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.
리소스 형식
Microsoft.DocumentDB/databaseAccounts 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2021-04-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"connectorOffer": "Small",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"disableKeyBasedMetadataWriteAccess": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
],
"createMode": "string"
// For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
}
}
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties 개체
createMode 속성을 설정하여 개체 유형을 지정합니다.
기본값의 경우 다음을 사용합니다.
"createMode": "Default"
복원의 경우 다음을 사용합니다.
"createMode": "Restore",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"restoreMode": "PointInTime",
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
BackupPolicy 개체
형식 속성을 설정하여 개체의 형식을 지정합니다.
연속의 경우 다음을 사용합니다.
"type": "Continuous"
주기적인 경우 다음을 사용합니다.
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
}
속성 값
databaseAccounts
| Name | Description | 값 |
|---|---|---|
| 형식 | 리소스 종류 | 'Microsoft.DocumentDB/databaseAccounts' |
| apiVersion | 리소스 api 버전 | '2021-04-01-preview' |
| name | 리소스 이름 | string(필수) 문자 제한: 3-44 유효한 문자: 소문자, 숫자 및 하이픈 소문자 또는 숫자로 시작합니다. 리소스 이름은 Azure에서 고유해야 합니다. |
| 위치 | 리소스가 속한 리소스 그룹의 위치입니다. | string |
| tags | 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. | 태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요. |
| kind | 데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다. | 'GlobalDocumentDB' 'MongoDB' '구문 분석' |
| identity | 리소스의 ID입니다. | ManagedServiceIdentity |
| properties | Azure Cosmos DB 데이터베이스 계정을 만들고 업데이트하는 속성입니다. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (필수) |
ManagedServiceIdentity
| Name | Description | 값 |
|---|---|---|
| 형식 | 리소스에 사용되는 ID 유형입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | 값 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Description | 값 |
|---|---|---|
| apiProperties | API 관련 속성입니다. 현재 MongoDB API에 대해서만 지원됩니다. | ApiProperties |
| backupPolicy | 계정에서 백업을 수행하는 정책을 나타내는 개체입니다. | BackupPolicy |
| capabilities | 계정에 대한 Cosmos DB 기능 목록 | Capability[] |
| connectorOffer | Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. | 'Small' |
| consistencyPolicy | Cosmos DB 계정에 대한 일관성 정책입니다. | ConsistencyPolicy |
| cors | Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. | CorsPolicy[] |
| databaseAccountOfferType | 데이터베이스에 대한 제품 유형 | 'Standard'(필수) |
| defaultIdentity | 고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. | string |
| disableKeyBasedMetadataWriteAccess | 계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 | bool |
| enableAnalyticalStorage | 스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| enableAutomaticFailover | 가동 중단으로 인해 지역을 사용할 수 없는 드문 경우 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)는 계정에 대한 새 쓰기 지역을 생성하고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. | bool |
| enableCassandraConnector | Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. | bool |
| enableFreeTier | 무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. | bool |
| enableMultipleWriteLocations | 계정이 여러 위치에 쓸 수 있도록 합니다. | bool |
| ipRules | IpRules 목록입니다. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| keyVaultKeyUri | 키 자격 증명 모음의 URI | string |
| 위치 | Cosmos DB 계정에 대해 사용하도록 설정된 지리 복제 위치를 포함하는 배열입니다. | Location[] (필수) |
| networkAclBypass | 방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. | 'AzureServices' 'None' |
| networkAclBypassResourceIds | Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. | string[] |
| publicNetworkAccess | 공용 네트워크의 요청 허용 여부 | 'Disabled' 'Enabled' |
| virtualNetworkRules | Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. | VirtualNetworkRule[] |
| createMode | 개체 유형 설정 | 기본값 복원 (필수) |
ApiProperties
| Name | Description | 값 |
|---|---|---|
| serverVersion | MongoDB 계정의 ServerVersion에 대해 설명합니다. | '3.2' '3.6' '4.0' |
BackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 개체 유형 설정 | 연속 주기적 (필수) |
ContinuousModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | '연속'(필수) |
PeriodicModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | '주기적'(필수) |
| periodicModeProperties | 주기적 모드 백업에 대한 구성 값 | PeriodicModeProperties |
PeriodicModeProperties
| Name | Description | 값 |
|---|---|---|
| backupIntervalInMinutes | 두 백업 사이의 간격(분)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupRetentionIntervalInHours | 각 백업이 보존되는 시간(시간)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupStorageRedundancy | 백업 상주 유형을 나타내는 열거형 | 'Geo' 'Local' 'Zone' |
기능
| Name | Description | 값 |
|---|---|---|
| name | Cosmos DB 기능의 이름입니다. 예를 들어 "name": "EnableCassandra"입니다. 현재 값에는 "EnableTable" 및 "EnableGremlin"도 포함됩니다. | string |
ConsistencyPolicy
| Name | Description | 값 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다. | 'BoundedStaleness' 'ConsistentPrefix' '최종' 'Session' 'Strong'(필수) |
| maxIntervalInSeconds | 제한된 부실 일관성 수준과 함께 사용하는 경우 이 값은 허용되는 부실(초)의 시간을 나타냅니다. 이 값에 허용되는 범위는 5 - 86400입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 5 최대값 = 86400 |
| maxStalenessPrefix | 제한된 부실 일관성 수준과 함께 사용하는 경우 이 값은 허용되는 부실 요청 수를 나타냅니다. 이 값의 허용 범위는 1-2,147,483,647입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
CorsPolicy
| Name | Description | 값 |
|---|---|---|
| allowedHeaders | 원본 도메인이 CORS 요청에 대해 지정할 수 있는 요청 헤더입니다. | 문자열 |
| allowedMethods | 원본 도메인이 CORS 요청에 사용할 수 있는 메서드(HTTP 요청 동사)입니다. | 문자열 |
| allowedOrigins | CORS를 통해 서비스에 대한 요청을 할 수 있는 원본 도메인입니다. | string(필수) |
| exposedHeaders | CORS 요청에 대한 응답에 포함하여 전송할 수 있으며 브라우저에서 요청 발급자에게 표시할 수 있는 응답 헤더입니다. | 문자열 |
| maxAgeInSeconds | 브라우저가 실행 전 OPTIONS 요청을 캐시해야 하는 최대 시간입니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
IpAddressOrRange
| Name | Description | 값 |
|---|---|---|
| ipAddressOrRange | 단일 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". | 문자열 |
위치
| 이름 | Description | 값 |
|---|---|---|
| failoverPriority | 지역의 장애 조치(failover) 우선 순위입니다. 장애 조치 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치(failover) 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다. | int 제약 조건: 최소값 = 0 |
| isZoneRedundant | 이 지역이 AvailabilityZone 지역인지 여부를 나타내는 플래그 | bool |
| locationName | 영역의 이름입니다. | string |
VirtualNetworkRule
| Name | Description | 값 |
|---|---|---|
| id | 서브넷의 리소스 ID(예: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}). | string |
| ignoreMissingVNetServiceEndpoint | 가상 네트워크에 vnet 서비스 엔드포인트를 사용하도록 설정하기 전에 방화벽 규칙을 만듭니다. | bool |
DefaultRequestDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | 'Default'(필수) |
RestoreReqeustDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | 'Restore'(필수) |
| restoreParameters | 복원에 대한 정보를 나타내는 매개 변수입니다. | RestoreParameters |
RestoreParameters
| Name | Description | 값 |
|---|---|---|
| databasesToRestore | 복원에 사용할 수 있는 특정 데이터베이스 목록입니다. | DatabaseRestoreResource[] |
| restoreMode | 복원 모드를 설명합니다. | 'PointInTime' |
| restoreSource | 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | 계정을 복원해야 하는 시간입니다(ISO-8601 형식). | string |
DatabaseRestoreResource
| Name | Description | 값 |
|---|---|---|
| collectionNames | 복원에 사용할 수 있는 컬렉션의 이름입니다. | string[] |
| databaseName | 복원에 사용할 수 있는 데이터베이스의 이름입니다. | 문자열 |
빠른 시작 템플릿
다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.
| 템플릿 | Description |
|---|---|
| AKS(Azure Container Service)에서 Jenkins를 사용하는 CI/CD |
컨테이너를 사용하면 애플리케이션을 지속적으로 빌드하고 배포할 수 있습니다. Azure Container Service에서 Kubernetes를 사용하여 해당 컨테이너의 배포를 오케스트레이션하면 복제 가능하고 관리 가능한 컨테이너 클러스터를 달성할 수 있습니다. 컨테이너 이미지 및 오케스트레이션을 생성하도록 연속 빌드를 설정하면 배포의 속도와 안정성을 높일 수 있습니다. |
| SQL Database, Azure Cosmos DB, Azure Search를 사용하는 웹앱 |
이 템플릿은 웹앱, SQL Database, Azure Cosmos DB, Azure Search 및 Application Insights를 프로비전합니다. |
| Cassandra API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 키스페이스와 전용 처리량이 있는 테이블이 있는 두 지역에 Cassandra API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Cassandra API에 대한 자동 크기 조정 Azure Cosmos DB 계정 만들기 |
이 템플릿은 자동 크기 조정 처리량이 있는 키스페이스와 테이블이 있는 두 지역에 Cassandra API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Azure CosmosDB 계정 만들기 |
이 ARM 템플릿은 필요한 최소한의 값으로 CosmosDB 계정을 신속하게 만들기 위한 것입니다. |
| 여러 지역에서 Azure Cosmos DB 계정 만들기 |
이 템플릿은 일관성 수준 및 장애 조치(failover) 유형을 선택한 기본 및 보조 지역이 있는 모든 데이터베이스 API 유형에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 무료 계층 Azure Cosmos DB 계정 만들기 |
이 템플릿은 공유 처리량 및 컨테이너가 있는 데이터베이스를 사용하여 SQL API에 대한 무료 계층 Azure Cosmos DB 계정을 만듭니다. |
| Gremlin API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 전용 처리량을 사용하여 하나의 데이터베이스와 하나의 그래프가 있는 두 지역에 Gremlin API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| Gremlin API 자동 크기 조정에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 자동 크기 조정 처리량을 사용하여 하나의 데이터베이스와 하나의 그래프가 있는 두 지역에 Gremlin API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| MongoDB API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 두 개의 컬렉션이 있는 공유 및 전용 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다. |
| MongoDB API 자동 크기 조정에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 공유 및 전용 자동 크기 조정 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 프라이빗 엔드포인트를 사용하여 Azure Cosmos DB 계정 만들기 |
이 템플릿은 Cosmos 계정을 가상 네트워크에 노출하는 Cosmos 계정, 가상 네트워크 및 프라이빗 엔드포인트를 만듭니다. |
| Core(SQL) API에 대한 Azure Cosmos DB 계정 만들기 |
이 템플릿은 다른 여러 옵션이 있는 처리량이 있는 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| 분석 저장소가 있는 Azure Cosmos DB 계정 SQL API |
이 템플릿은 분석 저장소로 구성된 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| 자동 크기 조정을 사용하여 Azure Cosmos DB 계정 SQL API 만들기 |
이 템플릿은 다른 여러 옵션이 있는 자동 크기 조정 처리량이 있는 데이터베이스 및 컨테이너를 사용하여 Core(SQL) API에 대한 Azure Cosmos 계정을 만듭니다. |
| Azure Cosmos DB Core(SQL) API 저장 프로시저 만들기 |
이 템플릿은 Core(SQL) API에 대한 Azure Cosmos DB 계정과 저장 프로시저, 트리거 및 사용자 정의 함수가 있는 컨테이너를 만듭니다. |
| Core(SQL) API에 대한 최소 Azure Cosmos DB 계정 만들기 |
이 템플릿은 필요한 최소한의 리소스 속성만 지정하면서 Core(SQL) API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| SQL API 및 여러 컨테이너를 사용하여 Azure Cosmos 만들기 |
템플릿은 SQL API를 사용하여 Cosmos 컨테이너를 만들고 mulitple 컨테이너를 추가할 수 있습니다. |
| 데이터 평면 RBAC를 사용하여 Azure Cosmos DB SQL 계정 만들기 |
이 템플릿은 SQL Cosmos 계정, 고유하게 유지 관리되는 역할 정의 및 AAD ID에 대해 고유하게 유지 관리되는 역할 할당을 만듭니다. |
| SQL API에 대한 서버리스 Azure Cosmos DB 계정 만들기 |
이 템플릿은 Core(SQL) API에 대한 서버리스 Azure Cosmos DB 계정을 만듭니다. |
| Table API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 프로비전된 처리량이 있는 단일 테이블과 두 지역에 Table API에 대한 Azure Cosmos DB 계정을 만듭니다. |
| 자동 크기 조정을 사용하여 Table API에 대한 Azure Cosmos 계정 만들기 |
이 템플릿은 두 지역에 Table API에 대한 Azure Cosmos DB 계정과 자동 크기 조정 처리량이 있는 단일 테이블을 만듭니다. |
| 제로 터치 Azure Cosmos 계정 및 Azure Web App 만들기 |
이 템플릿은 Azure Cosmos 계정을 만들고, Cosmos DB 엔드포인트 및 키를 Azure Web App 설정에 삽입한 다음, GitHub에서 ASP MVC 웹앱을 배포합니다. |
| Microsoft Defender를 사용하도록 설정된 Cosmos DB 계정 만들기 |
이 ARM 템플릿을 사용하여 Azure Cosmos DB용 Microsoft Defender를 사용하도록 설정된 Azure Cosmos DB 계정을 배포할 수 있습니다. Azure Cosmos DB용 Microsoft Defender는 Azure Cosmos DB 계정의 데이터베이스를 악용하려는 모든 시도를 검색하는 Azure 네이티브 보안 계층입니다. Azure Cosmos DB용 Microsoft Defender는 잠재적인 SQL 삽입, Microsoft 위협 인텔리전스 기반의 알려진 악의적인 행위자, 의심스러운 액세스 패턴 및 손상된 ID 또는 악의적인 내부자를 통해 데이터베이스의 잠재적 악용을 검색합니다. |
| Cosmos DB 연결을 사용하여 Azure Data Explorer DB 배포 |
Cosmos DB 연결을 사용하여 Azure Data Explorer DB를 배포합니다. |
| 웹앱을 사용하는 Azure Cosmos DB 계정 |
이 템플릿은 Azure Cosmos DB 계정, App Service 계획을 배포하고 App Service 계획에 웹앱을 만듭니다. 또한 Azure Cosmos DB 계정 엔드포인트를 참조하는 웹앱에 두 개의 애플리케이션 설정을 추가합니다. 이러한 방식으로 웹앱에 배포된 솔루션은 이러한 설정을 사용하여 Azure Cosmos DB 계정 엔드포인트에 연결할 수 있습니다. |
Terraform(AzAPI 공급자) 리소스 정의
databaseAccounts 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
- 리소스 그룹
각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.
리소스 형식
Microsoft.DocumentDB/databaseAccounts 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
connectorOffer = "Small"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
disableKeyBasedMetadataWriteAccess = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
createMode = "string"
// For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
}
kind = "string"
})
}
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties 개체
createMode 속성을 설정하여 개체 유형을 지정합니다.
기본값으로 다음을 사용합니다.
createMode = "Default"
복원의 경우 다음을 사용합니다.
createMode = "Restore"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
restoreMode = "PointInTime"
restoreSource = "string"
restoreTimestampInUtc = "string"
}
BackupPolicy 개체
형식 속성을 설정하여 개체의 형식을 지정합니다.
연속의 경우 다음을 사용합니다.
type = "Continuous"
주기적인 경우 다음을 사용합니다.
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
속성 값
databaseAccounts
| Name | Description | 값 |
|---|---|---|
| 형식 | 리소스 종류 | "Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview" |
| name | 리소스 이름 | string(필수) 문자 제한: 3-44 유효한 문자: 소문자, 숫자 및 하이픈 소문자 또는 숫자로 시작합니다. 리소스 이름은 Azure에서 고유해야 합니다. |
| 위치 | 리소스가 속한 리소스 그룹의 위치입니다. | string |
| parent_id | 리소스 그룹에 배포하려면 해당 리소스 그룹의 ID를 사용합니다. | string(필수) |
| tags | 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. | 태그 이름 및 값의 사전입니다. |
| kind | 데이터베이스 계정의 유형을 나타냅니다. 데이터베이스 계정을 만들 때만 설정할 수 있습니다. | "GlobalDocumentDB" "MongoDB" "구문 분석" |
| identity | 리소스의 ID입니다. | ManagedServiceIdentity |
| properties | Azure Cosmos DB 데이터베이스 계정을 만들고 업데이트하는 속성입니다. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (필수) |
ManagedServiceIdentity
| Name | Description | 값 |
|---|---|---|
| 형식 | 리소스에 사용되는 ID 유형입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. | 사용자 ID ID의 배열입니다. |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | 값 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Description | 값 |
|---|---|---|
| apiProperties | API 관련 속성입니다. 현재 MongoDB API에 대해서만 지원됩니다. | ApiProperties |
| backupPolicy | 계정에서 백업을 수행하는 정책을 나타내는 개체입니다. | BackupPolicy |
| capabilities | 계정에 대한 Cosmos DB 기능 목록 | Capability[] |
| connectorOffer | Cosmos DB 데이터베이스 C* 계정에 대한 cassandra 커넥터 제품 유형입니다. | "Small" |
| consistencyPolicy | Cosmos DB 계정에 대한 일관성 정책입니다. | ConsistencyPolicy |
| cors | Cosmos DB 데이터베이스 계정에 대한 CORS 정책입니다. | CorsPolicy[] |
| databaseAccountOfferType | 데이터베이스에 대한 제품 유형 | "표준"(필수) |
| defaultIdentity | 고객 관리형 키와 같은 기능에 사용되는 키 자격 증명 모음에 액세스하기 위한 기본 ID입니다. 기본 ID는 사용자가 명시적으로 설정해야 합니다. "FirstPartyIdentity", "SystemAssignedIdentity" 등이 될 수 있습니다. | string |
| disableKeyBasedMetadataWriteAccess | 계정 키를 통해 메타데이터 리소스(데이터베이스, 컨테이너, 처리량)에 대한 쓰기 작업 사용 안 함 | bool |
| enableAnalyticalStorage | 스토리지 분석을 사용하도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| enableAutomaticFailover | 가동 중단으로 인해 지역을 사용할 수 없는 드문 경우 쓰기 지역의 자동 장애 조치(failover)를 사용하도록 설정합니다. 자동 장애 조치(failover)는 계정에 대한 새 쓰기 지역을 생성하고 계정에 대해 구성된 장애 조치(failover) 우선 순위에 따라 선택됩니다. | bool |
| enableCassandraConnector | Cosmos DB C* 계정에서 cassandra 커넥터를 사용하도록 설정합니다. | bool |
| enableFreeTier | 무료 계층을 사용할 수 있는지 여부를 나타내는 플래그입니다. | bool |
| enableMultipleWriteLocations | 계정이 여러 위치에 쓸 수 있도록 합니다. | bool |
| ipRules | IpRules 목록입니다. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Virtual Network ACL 규칙을 사용/사용하지 않도록 설정할지 여부를 나타내는 플래그입니다. | bool |
| keyVaultKeyUri | 키 자격 증명 모음의 URI | string |
| 위치 | Cosmos DB 계정에 대해 사용하도록 설정된 지리 복제 위치를 포함하는 배열입니다. | Location[] (필수) |
| networkAclBypass | 방화벽 검사를 무시할 수 있는 서비스를 나타냅니다. | "AzureServices" “None” |
| networkAclBypassResourceIds | Cosmos DB 계정에 대한 네트워크 Acl 바이패스에 대한 리소스 ID를 포함하는 배열입니다. | string[] |
| publicNetworkAccess | 공용 네트워크의 요청 허용 여부 | "사용 안 함" "사용" |
| virtualNetworkRules | Cosmos DB 계정에 대해 구성된 Virtual Network ACL 규칙 목록입니다. | VirtualNetworkRule[] |
| createMode | 개체 유형 설정 | 기본값 복원 (필수) |
ApiProperties
| Name | Description | 값 |
|---|---|---|
| serverVersion | MongoDB 계정의 ServerVersion에 대해 설명합니다. | "3.2" "3.6" "4.0" |
BackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 개체 유형 설정 | 연속 주기적 (필수) |
ContinuousModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | "연속"(필수) |
PeriodicModeBackupPolicy
| Name | Description | 값 |
|---|---|---|
| 형식 | 백업 모드를 설명합니다. | "주기적"(필수) |
| periodicModeProperties | 주기적 모드 백업에 대한 구성 값 | PeriodicModeProperties |
PeriodicModeProperties
| Name | Description | 값 |
|---|---|---|
| backupIntervalInMinutes | 두 백업 사이의 간격(분)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupRetentionIntervalInHours | 각 백업이 보존되는 시간(시간)을 나타내는 정수입니다. | int 제약 조건: 최소값 = 0 |
| backupStorageRedundancy | 백업 상주 유형을 나타내는 열거형 | "지역" "로컬" "영역" |
기능
| Name | Description | 값 |
|---|---|---|
| name | Cosmos DB 기능의 이름입니다. 예를 들어 "name": "EnableCassandra"입니다. 현재 값에는 "EnableTable" 및 "EnableGremlin"도 포함됩니다. | 문자열 |
ConsistencyPolicy
| Name | Description | 값 |
|---|---|---|
| defaultConsistencyLevel | Cosmos DB 계정의 기본 일관성 수준 및 구성 설정입니다. | "BoundedStaleness" "ConsistentPrefix" "최종" "세션" "Strong"(필수) |
| maxIntervalInSeconds | 제한된 부실 일관성 수준과 함께 사용할 경우 이 값은 허용되는 부실 시간(초)을 나타냅니다. 이 값에 허용되는 범위는 5 - 86400입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 5 최대값 = 86400 |
| maxStalenessPrefix | 제한된 부실 일관성 수준과 함께 사용할 경우 이 값은 허용되는 부실 요청 수를 나타냅니다. 이 값의 허용 범위는 1-2,147,483,647입니다. defaultConsistencyPolicy가 'BoundedStaleness'로 설정된 경우 필요합니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
CorsPolicy
| Name | Description | 값 |
|---|---|---|
| allowedHeaders | 원본 도메인이 CORS 요청에 대해 지정할 수 있는 요청 헤더입니다. | 문자열 |
| allowedMethods | 원본 도메인이 CORS 요청에 사용할 수 있는 메서드(HTTP 요청 동사)입니다. | 문자열 |
| allowedOrigins | CORS를 통해 서비스에 대한 요청을 할 수 있는 원본 도메인입니다. | string(필수) |
| exposedHeaders | CORS 요청에 대한 응답에 포함하여 전송할 수 있으며 브라우저에서 요청 발급자에게 표시할 수 있는 응답 헤더입니다. | string |
| maxAgeInSeconds | 브라우저가 실행 전 OPTIONS 요청을 캐시해야 하는 최대 시간입니다. | int 제약 조건: 최소값 = 1 최대값 = 2147483647 |
IpAddressOrRange
| Name | Description | 값 |
|---|---|---|
| ipAddressOrRange | 단일 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". | 문자열 |
위치
| 이름 | Description | 값 |
|---|---|---|
| failoverPriority | 지역의 장애 조치(failover) 우선 순위입니다. 장애 조치 우선 순위 0은 쓰기 지역을 나타냅니다. 장애 조치(failover) 우선 순위 = (총 지역 수 - 1)의 최대값입니다. 장애 조치 우선 순위 값은 데이터베이스 계정이 있는 각 지역에 대해 고유해야 합니다. | int 제약 조건: 최소값 = 0 |
| isZoneRedundant | 이 지역이 AvailabilityZone 지역인지 여부를 나타내는 플래그 | bool |
| locationName | 영역의 이름입니다. | string |
VirtualNetworkRule
| Name | Description | 값 |
|---|---|---|
| id | 서브넷의 리소스 ID(예: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}). | string |
| ignoreMissingVNetServiceEndpoint | 가상 네트워크에 vnet 서비스 엔드포인트가 활성화되기 전에 방화벽 규칙을 만듭니다. | bool |
DefaultRequestDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | "기본값"(필수) |
RestoreReqeustDatabaseAccountCreateUpdateProperties
| Name | Description | 값 |
|---|---|---|
| createMode | 계정 만들기 모드를 나타내는 열거형입니다. | "복원"(필수) |
| restoreParameters | 복원에 대한 정보를 나타내는 매개 변수입니다. | RestoreParameters |
RestoreParameters
| Name | Description | 값 |
|---|---|---|
| databasesToRestore | 복원에 사용할 수 있는 특정 데이터베이스 목록입니다. | DatabaseRestoreResource[] |
| restoreMode | 복원 모드를 설명합니다. | "PointInTime" |
| restoreSource | 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | 계정을 복원해야 하는 시간입니다(ISO-8601 형식). | 문자열 |
DatabaseRestoreResource
| Name | Description | 값 |
|---|---|---|
| collectionNames | 복원에 사용할 수 있는 컬렉션의 이름입니다. | string[] |
| databaseName | 복원에 사용할 수 있는 데이터베이스의 이름입니다. | string |