Microsoft.DocumentDB databaseAccounts/services 2024-05-15-preview

  • [アーティクル]

Bicep リソース定義

databaseAccounts/services リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/services リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/services@2024-05-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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 の場合は、次の値を使用します。

  serviceType: 'SqlDedicatedGateway'
  dedicatedGatewayType: 'string'

プロパティ値

databaseAccounts/services

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボリック名: databaseAccounts
properties ServiceResourceCreateUpdateParameters のプロパティ。 ServiceResourceCreateUpdatePropertiesOrServiceResour...

ServiceResourceCreateUpdatePropertiesOrServiceResour...

名前 説明 値
instanceCount サービスのインスタンス数。 INT

制約:
最小値 = 0
instanceSize サービスのインスタンスの種類。 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
serviceType オブジェクトの種類を設定する DataTransfer
GraphAPICompute
MaterializedViewsBuilder
SqlDedicatedGateway (必須)

DataTransferServiceResourceCreateUpdateParametersOrD...

名前 説明 値
serviceType サービスの ServiceType。 'DataTransfer' (必須)

GraphAPIComputeServiceResourceCreateUpdateParameters...

名前 説明 値
serviceType サービスの ServiceType。 'GraphAPICompute' (必須)

MaterializedViewsBuilderServiceResourceCreateUpdateP...

名前 説明 値
serviceType サービスの ServiceType。 'MaterializedViewsBuilder' (必須)

SqlDedicatedGatewayServiceResourceCreateUpdateParame...

名前 説明 値
serviceType サービスの ServiceType。 'SqlDedicatedGateway' (必須)
dedicatedGatewayType サービスの DedicatedGatewayType。 'DistributedQuery'
'IntegratedCache'

ARM テンプレート リソース定義

databaseAccounts/services リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/services リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/services",
  "apiVersion": "2024-05-15-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 の場合は、次の値を使用します。

  "serviceType": "SqlDedicatedGateway",
  "dedicatedGatewayType": "string"

プロパティ値

databaseAccounts/services

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/services'
apiVersion リソース API のバージョン '2024-05-15-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties ServiceResourceCreateUpdateParameters のプロパティ。 ServiceResourceCreateUpdatePropertiesOrServiceResour...

ServiceResourceCreateUpdatePropertiesOrServiceResour...

名前 説明 値
instanceCount サービスのインスタンス数。 INT

制約:
最小値 = 0
instanceSize サービスのインスタンスの種類。 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
serviceType オブジェクトの種類を設定する DataTransfer
GraphAPICompute
MaterializedViewsBuilder
SqlDedicatedGateway (必須)

DataTransferServiceResourceCreateUpdateParametersOrD...

名前 説明 値
serviceType サービスの ServiceType。 'DataTransfer' (必須)

GraphAPIComputeServiceResourceCreateUpdateParameters...

名前 説明 値
serviceType サービスの ServiceType。 'GraphAPICompute' (必須)

MaterializedViewsBuilderServiceResourceCreateUpdateP...

名前 説明 値
serviceType サービスの ServiceType。 'MaterializedViewsBuilder' (必須)

SqlDedicatedGatewayServiceResourceCreateUpdateParame...

名前 説明 値
serviceType サービスの ServiceType。 'SqlDedicatedGateway' (必須)
dedicatedGatewayType サービスの DedicatedGatewayType。 'DistributedQuery'
'IntegratedCache'

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts/services リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/services リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/services@2024-05-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    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 の場合は、次の値を使用します。

  serviceType = "SqlDedicatedGateway"
  dedicatedGatewayType = "string"

プロパティ値

databaseAccounts/services

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/services@2024-05-15-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
properties ServiceResourceCreateUpdateParameters のプロパティ。 ServiceResourceCreateUpdatePropertiesOrServiceResour...

ServiceResourceCreateUpdatePropertiesOrServiceResour...

名前 説明 値
instanceCount サービスのインスタンス数。 INT

制約:
最小値 = 0
instanceSize サービスのインスタンスの種類。 "Cosmos.D16s"
"Cosmos.D4s"
"Cosmos.D8s"
serviceType オブジェクトの種類を設定する DataTransfer
GraphAPICompute
MaterializedViewsBuilder
SqlDedicatedGateway (必須)

DataTransferServiceResourceCreateUpdateParametersOrD...

名前 説明 値
serviceType サービスの ServiceType。 "DataTransfer" (必須)

GraphAPIComputeServiceResourceCreateUpdateParameters...

名前 説明 値
serviceType サービスの ServiceType。 "GraphAPICompute" (必須)

MaterializedViewsBuilderServiceResourceCreateUpdateP...

名前 説明 値
serviceType サービスの ServiceType。 "MaterializedViewsBuilder" (必須)

SqlDedicatedGatewayServiceResourceCreateUpdateParame...

名前 説明 値
serviceType サービスの ServiceType。 "SqlDedicatedGateway" (必須)
dedicatedGatewayType サービスの DedicatedGatewayType。 "DistributedQuery"
"IntegratedCache"