Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-11-15
이 문서의 내용
Bicep 리소스 정의
databaseAccounts/mongodbDatabases/collections 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그 를 참조하세요.
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
createMode: 'string'
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
shardKey: {
{customized property}: 'string'
}
}
}
}
속성 값
databaseAccounts/mongodbDatabases/collections
Name
Description
값
name
리소스 이름Bicep 에서 자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.
string(필수)
위치
리소스가 속한 리소스 그룹의 위치입니다.
string
tags
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요.
부모(parent)
Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가하면 됩니다. 자세한 내용은 부모 리소스 외부의 자식 리소스 를 참조하세요.
형식의 리소스에 대한 기호 이름: mongodbDatabases
properties
Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Name
Description
값
autoscaleSettings
자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
AutoscaleSettings
throughput
초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다.
int
AutoscaleSettings
Name
Description
값
maxThroughput
최대 처리량을 나타내며 리소스를 확장할 수 있습니다.
int
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
Name
Description
값
analyticalStorageTtl
분석 TTL.
int
createMode
리소스 생성 모드를 나타내는 열거형입니다.
'기본값' '복원'
id
Cosmos DB MongoDB 컬렉션의 이름
string(필수)
인덱스
인덱스 키 목록
MongoIndex []
restoreParameters
복원에 대한 정보를 나타내는 매개 변수
ResourceRestoreParameters
shardKey
요청에 적용할 분할 키의 키-값 쌍입니다.
ShardKeys
MongoIndex
MongoIndexKeys
Name
Description
값
키
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록
string[]
MongoIndexOptions
Name
Description
값
expireAfterSeconds
초 후 만료
int
unique
고유 여부
bool
ResourceRestoreParameters
Name
Description
값
restoreSource
복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
문자열
restoreTimestampInUtc
계정을 복원해야 하는 시간(ISO-8601 형식).
문자열
ShardKeys
Name
Description
값
{customized property}
문자열
빠른 시작 템플릿
다음 빠른 시작 템플릿은 이 리소스 종류를 배포합니다.
ARM 템플릿 리소스 정의
databaseAccounts/mongodbDatabases/collections 리소스 종류는 다음을 대상으로 하는 작업과 함께 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그 를 참조하세요.
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2023-11-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"createMode": "string",
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"shardKey": {
"{customized property}": "string"
}
}
}
}
속성 값
databaseAccounts/mongodbDatabases/collections
Name
Description
값
형식
리소스 종류
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
apiVersion
리소스 api 버전
'2023-11-15'
name
리소스 이름JSON ARM 템플릿 에서 자식 리소스의 이름 및 형식을 설정하는 방법을 참조하세요.
string(필수)
위치
리소스가 속한 리소스 그룹의 위치입니다.
string
tags
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요.
properties
Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Name
Description
값
autoscaleSettings
자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
AutoscaleSettings
throughput
초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다.
int
AutoscaleSettings
Name
Description
값
maxThroughput
최대 처리량을 나타내며 리소스를 확장할 수 있습니다.
int
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
Name
Description
값
analyticalStorageTtl
분석 TTL.
int
createMode
리소스 만들기 모드를 나타내는 열거형입니다.
'기본값' '복원'
id
Cosmos DB MongoDB 컬렉션의 이름
string(필수)
인덱스
인덱스 키 목록
MongoIndex []
restoreParameters
복원에 대한 정보를 나타내는 매개 변수
ResourceRestoreParameters
shardKey
요청에 적용할 분할 키의 키-값 쌍입니다.
ShardKeys
MongoIndex
MongoIndexKeys
Name
Description
값
키
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록
string[]
MongoIndexOptions
Name
Description
값
expireAfterSeconds
몇 초 후에 만료
int
unique
고유 여부
bool
ResourceRestoreParameters
Name
Description
값
restoreSource
복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
문자열
restoreTimestampInUtc
계정을 복원해야 하는 시간입니다(ISO-8601 형식).
문자열
ShardKeys
Name
Description
값
{사용자 지정 속성}
문자열
빠른 시작 템플릿
다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.
databaseAccounts/mongodbDatabases/collections 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.
각 API 버전에서 변경된 속성 목록은 변경 로그 를 참조하세요.
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
createMode = "string"
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
shardKey = {
{customized property} = "string"
}
}
}
})
}
속성 값
databaseAccounts/mongodbDatabases/collections
Name
Description
값
형식
리소스 종류
"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"
name
리소스 이름
string(필수)
위치
리소스가 속한 리소스 그룹의 위치입니다.
string
parent_id
이 리소스의 부모인 리소스의 ID입니다.
형식의 리소스 ID: mongodbDatabases
tags
태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
태그 이름 및 값의 사전입니다.
properties
Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Name
Description
값
autoscaleSettings
자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
AutoscaleSettings
throughput
초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다.
int
AutoscaleSettings
Name
Description
값
maxThroughput
최대 처리량을 나타내며 리소스를 확장할 수 있습니다.
int
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
Name
Description
값
analyticalStorageTtl
분석 TTL.
int
createMode
리소스 만들기 모드를 나타내는 열거형입니다.
"기본값" "복원"
id
Cosmos DB MongoDB 컬렉션의 이름
string(필수)
인덱스
인덱스 키 목록
MongoIndex []
restoreParameters
복원에 대한 정보를 나타내는 매개 변수
ResourceRestoreParameters
shardKey
요청에 적용할 분할 키의 키-값 쌍입니다.
ShardKeys
MongoIndex
MongoIndexKeys
Name
Description
값
키
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록
string[]
MongoIndexOptions
Name
Description
값
expireAfterSeconds
초 후 만료
int
unique
고유 여부
bool
ResourceRestoreParameters
Name
Description
값
restoreSource
복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
문자열
restoreTimestampInUtc
계정을 복원해야 하는 시간(ISO-8601 형식).
문자열
ShardKeys
Name
Description
값
{customized property}
string