Share via

Microsoft.DocumentDB databaseAccounts/api/databases/collections 2015-04-01

  • 아티클

Bicep 리소스 정의

databaseAccounts/api/databases/collections 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.

리소스 형식

Microsoft.DocumentDB/databaseAccounts/api/databases/collections 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

속성 값

databaseAccounts/api/databases/collections

Name Description 값
name 리소스 이름

Bicep에서 자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.		 string(필수)
부모(parent) Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가하면 됩니다.

자세한 내용은 부모 리소스 외부의 자식 리소스를 참조하세요.		 형식의 리소스에 대한 기호 이름: 데이터베이스
properties Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Description 값
옵션 요청에 적용할 키-값 옵션 쌍입니다. 이는 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptions (필수)
resource MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResource (필수)

CreateUpdateOptions

Name Description 값
{사용자 지정 속성} 문자열

MongoDBCollectionResource

Name Description 값
id Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

Name Description 값
key Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

Name Description 값
키 Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

Name Description 값
expireAfterSeconds 몇 초 후에 만료 int
unique 고유 여부 bool

ShardKeys

Name Description 값
{사용자 지정 속성} 문자열

ARM 템플릿 리소스 정의

databaseAccounts/api/databases/collections 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.

리소스 형식

Microsoft.DocumentDB/databaseAccounts/api/databases/collections 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2015-04-01",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

속성 값

databaseAccounts/api/databases/collections

Name Description 값
형식 리소스 종류 'Microsoft.DocumentDB/databaseAccounts/api/databases/collections'
apiVersion 리소스 api 버전 '2015-04-01'
name 리소스 이름

JSON ARM 템플릿에서 자식 리소스의 이름 및 형식을 설정하는 방법을 참조하세요.		 string(필수)
properties Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Description 값
옵션 요청에 적용할 키-값 옵션 쌍입니다. 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptions (필수)
resource MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResource (필수)

CreateUpdateOptions

Name Description 값
{customized property} 문자열

MongoDBCollectionResource

Name Description 값
id Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

Name Description 값
key Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

Name Description 값
키 Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

Name Description 값
expireAfterSeconds 초 후 만료 int
unique 고유 여부 bool

ShardKeys

Name Description 값
{customized property} 문자열

Terraform(AzAPI 공급자) 리소스 정의

databaseAccounts/api/databases/collections 리소스 종류는 다음을 대상으로 하는 작업을 사용하여 배포할 수 있습니다.

  • 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.

리소스 형식

Microsoft.DocumentDB/databaseAccounts/api/databases/collections 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

속성 값

databaseAccounts/api/databases/collections

Name Description 값
형식 리소스 종류 "Microsoft.DocumentDB/databaseAccounts/api/databases/collections@2015-04-01"
name 리소스 이름 string(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스에 대한 ID: 데이터베이스
properties Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (필수)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Description 값
옵션 요청에 적용할 키-값 옵션 쌍입니다. 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptions (필수)
resource MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResource (필수)

CreateUpdateOptions

Name Description 값
{customized property} string

MongoDBCollectionResource

Name Description 값
id Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

Name Description 값
key Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

Name Description 값
키 Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

Name Description 값
expireAfterSeconds 초 후 만료 int
unique 고유 여부 bool

ShardKeys

Name Description 값
{customized property} string