다음을 통해 공유


Microsoft.DocumentDB 데이터베이스계정/서비스 2025-05-01-preview

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/services@2025-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    instanceCount: int
    instanceSize: 'string'
    serviceType: 'string'
    // For remaining properties, see ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects
  }
}

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties 개체

serviceType 속성을 설정하여 개체 유형을 지정합니다.

DataTransfer경우 다음을 사용합니다.

{
  serviceType: 'DataTransfer'
}

GraphAPICompute경우 다음을 사용합니다.

{
  serviceType: 'GraphAPICompute'
}

materializedViewsBuilder경우 다음을 사용합니다.

{
  serviceType: 'MaterializedViewsBuilder'
}

sqlDedicatedGateway경우 다음을 사용합니다.

{
  dedicatedGatewayType: 'string'
  serviceType: 'SqlDedicatedGateway'
}

속성 값

Microsoft.DocumentDB/databaseAccounts/services

이름 설명 가치
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 3
최대 길이 = 50(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식 리소스의 기호 이름: databaseAccounts
속성 ServiceResourceCreateUpdateParameters의 속성입니다. ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties

DataTransferServiceResourceCreateUpdateProperties또는DataTransferServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'DataTransfer'(필수)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'GraphAPICompute'(필수)

MaterializedViewsBuilderServiceResourceCreateUpdateProperties 또는 MaterializedViewsBuilderServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'MaterializedViewsBuilder'(필수)

ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties

이름 설명 가치
인스턴스 개수 서비스의 인스턴스 수입니다. 정수

제약 조건:
최소값 = 0
인스턴스 크기 서비스의 인스턴스 유형입니다. '코스모스.D16s'
'코스모스.D4s'
'코스모스.D8s'
서비스 유형 DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties형식에 대해 'DataTransfer'로 설정합니다. GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties 형식에 대해 'GraphAPICompute'로 설정합니다. MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties 형식에 대해 'MaterializedViewsBuilder'로 설정합니다. sqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties형식에 대해 'SqlDedicatedGateway'로 설정합니다. '데이터 전송'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway'(필수)

SqlDedicatedGatewayServiceResourceCreateUpdateProperties또는SqlDedicatedGatewayServiceResourceProperties

이름 설명 가치
전용게이트웨이 유형 서비스에 대한 DedicatedGatewayType입니다. '분산된 쿼리'
'통합 캐시'
서비스 유형 서비스에 대한 ServiceType입니다. 'SqlDedicatedGateway'(필수)

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/services",
  "apiVersion": "2025-05-01-preview",
  "name": "string",
  "properties": {
    "instanceCount": "int",
    "instanceSize": "string",
    "serviceType": "string"
    // For remaining properties, see ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects
  }
}

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties 개체

serviceType 속성을 설정하여 개체 유형을 지정합니다.

DataTransfer경우 다음을 사용합니다.

{
  "serviceType": "DataTransfer"
}

GraphAPICompute경우 다음을 사용합니다.

{
  "serviceType": "GraphAPICompute"
}

materializedViewsBuilder경우 다음을 사용합니다.

{
  "serviceType": "MaterializedViewsBuilder"
}

sqlDedicatedGateway경우 다음을 사용합니다.

{
  "dedicatedGatewayType": "string",
  "serviceType": "SqlDedicatedGateway"
}

속성 값

Microsoft.DocumentDB/databaseAccounts/services

이름 설명 가치
API버전 api 버전 '2025-05-01-미리보기'
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 3
최대 길이 = 50(필수)
속성 ServiceResourceCreateUpdateParameters의 속성입니다. ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties
유형 리소스 종류 'Microsoft.DocumentDB/databaseAccounts/services'

DataTransferServiceResourceCreateUpdateProperties또는DataTransferServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'DataTransfer'(필수)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'GraphAPICompute'(필수)

MaterializedViewsBuilderServiceResourceCreateUpdateProperties 또는 MaterializedViewsBuilderServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'MaterializedViewsBuilder'(필수)

ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties

이름 설명 가치
인스턴스 개수 서비스의 인스턴스 수입니다. 정수

제약 조건:
최소값 = 0
인스턴스 크기 서비스의 인스턴스 유형입니다. '코스모스.D16s'
'코스모스.D4s'
'코스모스.D8s'
서비스 유형 DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties형식에 대해 'DataTransfer'로 설정합니다. GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties 형식에 대해 'GraphAPICompute'로 설정합니다. MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties 형식에 대해 'MaterializedViewsBuilder'로 설정합니다. sqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties형식에 대해 'SqlDedicatedGateway'로 설정합니다. '데이터 전송'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway'(필수)

SqlDedicatedGatewayServiceResourceCreateUpdateProperties또는SqlDedicatedGatewayServiceResourceProperties

이름 설명 가치
전용게이트웨이 유형 서비스에 대한 DedicatedGatewayType입니다. '분산된 쿼리'
'통합 캐시'
서비스 유형 서비스에 대한 ServiceType입니다. 'SqlDedicatedGateway'(필수)

사용 예제

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

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

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/services@2025-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      instanceCount = int
      instanceSize = "string"
      serviceType = "string"
      // For remaining properties, see ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects
    }
  }
}

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties 개체

serviceType 속성을 설정하여 개체 유형을 지정합니다.

DataTransfer경우 다음을 사용합니다.

{
  serviceType = "DataTransfer"
}

GraphAPICompute경우 다음을 사용합니다.

{
  serviceType = "GraphAPICompute"
}

materializedViewsBuilder경우 다음을 사용합니다.

{
  serviceType = "MaterializedViewsBuilder"
}

sqlDedicatedGateway경우 다음을 사용합니다.

{
  dedicatedGatewayType = "string"
  serviceType = "SqlDedicatedGateway"
}

속성 값

Microsoft.DocumentDB/databaseAccounts/services

이름 설명 가치
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 3
최대 길이 = 50(필수)
부모 ID 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: databaseAccounts
속성 ServiceResourceCreateUpdateParameters의 속성입니다. ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties
유형 리소스 종류 "Microsoft.DocumentDB/databaseAccounts/services@2025-05-01-preview"

DataTransferServiceResourceCreateUpdateProperties또는DataTransferServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'DataTransfer'(필수)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'GraphAPICompute'(필수)

MaterializedViewsBuilderServiceResourceCreateUpdateProperties 또는 MaterializedViewsBuilderServiceResourceProperties

이름 설명 가치
서비스 유형 서비스에 대한 ServiceType입니다. 'MaterializedViewsBuilder'(필수)

ServiceResourceCreateUpdateProperties또는 ServiceResourceProperties

이름 설명 가치
인스턴스 개수 서비스의 인스턴스 수입니다. 정수

제약 조건:
최소값 = 0
인스턴스 크기 서비스의 인스턴스 유형입니다. '코스모스.D16s'
'코스모스.D4s'
'코스모스.D8s'
서비스 유형 DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties형식에 대해 'DataTransfer'로 설정합니다. GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties 형식에 대해 'GraphAPICompute'로 설정합니다. MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties 형식에 대해 'MaterializedViewsBuilder'로 설정합니다. sqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties형식에 대해 'SqlDedicatedGateway'로 설정합니다. '데이터 전송'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway'(필수)

SqlDedicatedGatewayServiceResourceCreateUpdateProperties또는SqlDedicatedGatewayServiceResourceProperties

이름 설명 가치
전용게이트웨이 유형 서비스에 대한 DedicatedGatewayType입니다. '분산된 쿼리'
'통합 캐시'
서비스 유형 서비스에 대한 ServiceType입니다. 'SqlDedicatedGateway'(필수)

사용 예제

Terraform 샘플

Cosmos DB 계정 내에서 SQL Dedicated Gateway를 배포하는 기본 예제입니다.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "service" {
  type      = "Microsoft.DocumentDB/databaseAccounts/services@2022-05-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = "SqlDedicatedGateway"
  body = {
    properties = {
      instanceCount = 1
      instanceSize  = "Cosmos.D4s"
      serviceType   = "SqlDedicatedGateway"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}