다음을 통해 공유


Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-05-15

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

속성 값

AutoscaleSettings

이름 묘사
maxThroughput 최대 처리량을 나타내며 리소스를 확장할 수 있습니다. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

이름 묘사
autoscaleSettings 자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다. AutoscaleSettings
처리량 초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

이름 묘사
위치 리소스가 속한 리소스 그룹의 위치입니다. 문자열
이름 리소스 이름 string(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식 리소스의 기호 이름: databaseAccounts/mongodbDatabases
속성 Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties(필수)
태그 리소스 태그 태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

이름 묘사
옵션 요청에 적용할 키-값 옵션 쌍입니다. 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
자원 MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource(필수)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

이름 묘사
analyticalStorageTtl 분석 TTL. int
createMode 리소스 생성 모드를 나타내는 열거형입니다. '기본값'
'복원'
아이디 Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
restoreParameters 복원에 대한 정보를 나타내는 매개 변수 resourceRestoreParameters
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

이름 묘사
열쇠 Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

이름 묘사
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

이름 묘사
expireAfterSeconds 초 후 만료 int
독특한 고유 여부 bool

ResourceRestoreParameters

이름 묘사
restoreSource 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 문자열
restoreTimestampInUtc 계정을 복원해야 하는 시간(ISO-8601 형식)입니다. 문자열

ShardKeys

이름 묘사

태그

이름 묘사

빠른 시작 샘플

다음 빠른 시작 샘플은 이 리소스 유형을 배포합니다.

Bicep 파일 묘사
MongoDB API 대한 Azure Cosmos 계정 만들기 이 템플릿은 두 개의 컬렉션이 있는 공유 및 전용 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다.
MongoDB API 자동 크기 조정 대한 Azure Cosmos 계정 만들기 이 템플릿은 공유 및 전용 자동 크기 조정 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다.

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

속성 값

AutoscaleSettings

이름 묘사
maxThroughput 최대 처리량을 나타내며 리소스를 확장할 수 있습니다. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

이름 묘사
autoscaleSettings 자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다. AutoscaleSettings
처리량 초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

이름 묘사
apiVersion api 버전 '2024-05-15'
위치 리소스가 속한 리소스 그룹의 위치입니다. 문자열
이름 리소스 이름 string(필수)
속성 Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties(필수)
태그 리소스 태그 태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요.
리소스 종류 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

이름 묘사
옵션 요청에 적용할 키-값 옵션 쌍입니다. 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
자원 MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource(필수)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

이름 묘사
analyticalStorageTtl 분석 TTL. int
createMode 리소스 생성 모드를 나타내는 열거형입니다. '기본값'
'복원'
아이디 Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
restoreParameters 복원에 대한 정보를 나타내는 매개 변수 resourceRestoreParameters
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

이름 묘사
열쇠 Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

이름 묘사
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

이름 묘사
expireAfterSeconds 초 후 만료 int
독특한 고유 여부 bool

ResourceRestoreParameters

이름 묘사
restoreSource 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 문자열
restoreTimestampInUtc 계정을 복원해야 하는 시간(ISO-8601 형식)입니다. 문자열

ShardKeys

이름 묘사

태그

이름 묘사

빠른 시작 템플릿

다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.

템플렛 묘사
MongoDB API 대한 Azure Cosmos 계정 만들기

Azure 배포
이 템플릿은 두 개의 컬렉션이 있는 공유 및 전용 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다.
MongoDB API 자동 크기 조정 대한 Azure Cosmos 계정 만들기

Azure 배포
이 템플릿은 공유 및 전용 자동 크기 조정 처리량을 사용하여 두 지역에 MongoDB API 4.2에 대한 Azure Cosmos DB 계정을 만듭니다.

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

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

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
        }
      }
    }
  })
}

속성 값

AutoscaleSettings

이름 묘사
maxThroughput 최대 처리량을 나타내며 리소스를 확장할 수 있습니다. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

이름 묘사
autoscaleSettings 자동 크기 조정 설정을 지정합니다. 참고: 처리량 또는 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다. AutoscaleSettings
처리량 초당 요청 단위입니다. 예를 들어 "처리량": 10000입니다. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

이름 묘사
위치 리소스가 속한 리소스 그룹의 위치입니다. 문자열
이름 리소스 이름 string(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: databaseAccounts/mongodbDatabases
속성 Azure Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 속성입니다. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties(필수)
태그 리소스 태그 태그 이름 및 값의 사전입니다.
리소스 종류 "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

이름 묘사
옵션 요청에 적용할 키-값 옵션 쌍입니다. 요청과 함께 전송된 헤더에 해당합니다. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
자원 MongoDB 컬렉션의 표준 JSON 형식 MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource(필수)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

이름 묘사
analyticalStorageTtl 분석 TTL. int
createMode 리소스 생성 모드를 나타내는 열거형입니다. '기본값'
'복원'
아이디 Cosmos DB MongoDB 컬렉션의 이름 string(필수)
인덱스 인덱스 키 목록 MongoIndex[]
restoreParameters 복원에 대한 정보를 나타내는 매개 변수 resourceRestoreParameters
shardKey 요청에 적용할 분할 키의 키-값 쌍입니다. ShardKeys

MongoIndex

이름 묘사
열쇠 Cosmos DB MongoDB 컬렉션 인덱스 키 MongoIndexKeys
옵션 Cosmos DB MongoDB 컬렉션 인덱스 키 옵션 MongoIndexOptions

MongoIndexKeys

이름 묘사
Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록 string[]

MongoIndexOptions

이름 묘사
expireAfterSeconds 초 후 만료 int
독특한 고유 여부 bool

ResourceRestoreParameters

이름 묘사
restoreSource 복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 문자열
restoreTimestampInUtc 계정을 복원해야 하는 시간(ISO-8601 형식)입니다. 문자열

ShardKeys

이름 묘사

태그

이름 묘사