Share via

Microsoft.DocumentDB databaseAccounts/services 2024-08-15

  • Article

Bicep resource definition

The databaseAccounts/services resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/services resource, add the following Bicep to your template.

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

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects

Set the serviceType property to specify the type of object.

For DataTransfer, use:

{
  serviceType: 'DataTransfer'
}

For GraphAPICompute, use:

{
  serviceType: 'GraphAPICompute'
}

For MaterializedViewsBuilder, use:

{
  serviceType: 'MaterializedViewsBuilder'
}

For SqlDedicatedGateway, use:

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

Property values

DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'DataTransfer' (required)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'GraphAPICompute' (required)

MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'MaterializedViewsBuilder' (required)

Microsoft.DocumentDB/databaseAccounts/services

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts
properties Properties in ServiceResourceCreateUpdateParameters. ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties

Name Description Value
instanceCount Instance count for the service. int

Constraints:
Min value = 0
instanceSize Instance type for the service. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
serviceType Set to 'DataTransfer' for type DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties. Set to 'GraphAPICompute' for type GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties. Set to 'MaterializedViewsBuilder' for type MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties. Set to 'SqlDedicatedGateway' for type SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties. 'DataTransfer'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway' (required)

SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties

Name Description Value
dedicatedGatewayType DedicatedGatewayType for the service. 'DistributedQuery'
'IntegratedCache'
serviceType ServiceType for the service. 'SqlDedicatedGateway' (required)

ARM template resource definition

The databaseAccounts/services resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/services resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/services",
  "apiVersion": "2024-08-15",
  "name": "string",
  "properties": {
    "instanceCount": "int",
    "instanceSize": "string",
    "serviceType": "string"
    // For remaining properties, see ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects
  }
}

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects

Set the serviceType property to specify the type of object.

For DataTransfer, use:

{
  "serviceType": "DataTransfer"
}

For GraphAPICompute, use:

{
  "serviceType": "GraphAPICompute"
}

For MaterializedViewsBuilder, use:

{
  "serviceType": "MaterializedViewsBuilder"
}

For SqlDedicatedGateway, use:

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

Property values

DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'DataTransfer' (required)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'GraphAPICompute' (required)

MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'MaterializedViewsBuilder' (required)

Microsoft.DocumentDB/databaseAccounts/services

Name Description Value
apiVersion The api version '2024-08-15'
name The resource name string

Constraints:
Min length = 3
Max length = 3 (required)
properties Properties in ServiceResourceCreateUpdateParameters. ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties
type The resource type 'Microsoft.DocumentDB/databaseAccounts/services'

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties

Name Description Value
instanceCount Instance count for the service. int

Constraints:
Min value = 0
instanceSize Instance type for the service. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
serviceType Set to 'DataTransfer' for type DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties. Set to 'GraphAPICompute' for type GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties. Set to 'MaterializedViewsBuilder' for type MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties. Set to 'SqlDedicatedGateway' for type SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties. 'DataTransfer'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway' (required)

SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties

Name Description Value
dedicatedGatewayType DedicatedGatewayType for the service. 'DistributedQuery'
'IntegratedCache'
serviceType ServiceType for the service. 'SqlDedicatedGateway' (required)

Terraform (AzAPI provider) resource definition

The databaseAccounts/services resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/services resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/services@2024-08-15"
  name = "string"
  body = jsonencode({
    properties = {
      instanceCount = int
      instanceSize = "string"
      serviceType = "string"
      // For remaining properties, see ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects
    }
  })
}

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties objects

Set the serviceType property to specify the type of object.

For DataTransfer, use:

{
  serviceType = "DataTransfer"
}

For GraphAPICompute, use:

{
  serviceType = "GraphAPICompute"
}

For MaterializedViewsBuilder, use:

{
  serviceType = "MaterializedViewsBuilder"
}

For SqlDedicatedGateway, use:

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

Property values

DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'DataTransfer' (required)

GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'GraphAPICompute' (required)

MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties

Name Description Value
serviceType ServiceType for the service. 'MaterializedViewsBuilder' (required)

Microsoft.DocumentDB/databaseAccounts/services

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Properties in ServiceResourceCreateUpdateParameters. ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties
type The resource type "Microsoft.DocumentDB/databaseAccounts/services@2024-08-15"

ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties

Name Description Value
instanceCount Instance count for the service. int

Constraints:
Min value = 0
instanceSize Instance type for the service. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
serviceType Set to 'DataTransfer' for type DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties. Set to 'GraphAPICompute' for type GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties. Set to 'MaterializedViewsBuilder' for type MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties. Set to 'SqlDedicatedGateway' for type SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties. 'DataTransfer'
'GraphAPICompute'
'MaterializedViewsBuilder'
'SqlDedicatedGateway' (required)

SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties

Name Description Value
dedicatedGatewayType DedicatedGatewayType for the service. 'DistributedQuery'
'IntegratedCache'
serviceType ServiceType for the service. 'SqlDedicatedGateway' (required)