Database Microsoft.DocumentDBAccounts/services

Definizione di risorsa Bicep

Il tipo di risorsa databaseAccounts/services può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Esempi di utilizzo

Esempi bicep

Esempio di base di distribuzione del gateway dedicato SQL all'interno di un account Cosmos DB.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  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: []
  }
}

resource service 'Microsoft.DocumentDB/databaseAccounts/services@2022-05-15' = {
  name: 'SqlDedicatedGateway'
  parent: databaseAccount
  properties: {
    instanceCount: 1
    instanceSize: 'Cosmos.D4s'
    serviceType: 'SqlDedicatedGateway'
  }
}

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/services, aggiungere il bicep seguente al modello.

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

Oggetti ServiceResourceProperties

Impostare la proprietà serviceType per specificare il tipo di oggetto.

Per DataTransfer, usare:

{
  instanceCount: int
  instanceSize: 'string'
  serviceType: 'DataTransfer'
}

Per SqlDedicatedGateway, usare:

{
  dedicatedGatewayType: 'string'
  instanceCount: int
  instanceSize: 'string'
  serviceType: 'SqlDedicatedGateway'
  sqlDedicatedGatewayEndpoint: 'string'
}

Per GraphAPICompute, usare:

{
  graphApiComputeEndpoint: 'string'
  instanceCount: int
  instanceSize: 'string'
  serviceType: 'GraphAPICompute'
}

Per MaterializedViewsBuilder, usare:

{
  instanceCount: int
  instanceSize: 'string'
  serviceType: 'MaterializedViewsBuilder'
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/services

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 50 (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: databaseAccounts
proprietà Risorsa di risposta dei servizi. ServiceResourceProperties

DataTrasferimentoServizioRisorsaProprietà

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'DataTransfer' (obbligatorio)

GraphAPIComputeServiceResourceProperties

Nome Descrizione Valore
graphApiComputeEndpoint Endpoint GraphAPICompute per il servizio. string
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'GraphAPICompute' (obbligatorio)

MaterializedViewsBuilderServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'MaterializedViewsBuilder' (obbligatorio)

ServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio Imposta su 'DataTransfer' per il tipo DataTransferServiceResourceProperties. Impostato su 'SqlDedicatedGateway' per il tipo SqlDedicatedGatewayServiceResourceProperties. Impostate su 'GraphAPICompute' per il tipo GraphAPIComputeServiceResourceProperties. Imposta su 'MaterializedViewsBuilder' per il tipo MaterializedViewsBuilderServiceResourceProperties. 'Trasferimento dati'
'GraphAPICompute'
'Costruttore di visualizzazioni materializzate'
'SqlDedicatedGateway' (obbligatorio)

SqlDedicatedGatewayServiceResourceProperties

Nome Descrizione Valore
dedicatoGatewayType DedicatedGatewayType per il servizio. 'Query distribuita'
'Cache integrata'
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'SqlDedicatedGateway' (obbligatorio)
sqlDedicatedGatewayEndpoint Endpoint SqlDedicatedGateway per il servizio. string

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa databaseAccounts/services può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/services, aggiungere il codice JSON seguente al modello.

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

Oggetti ServiceResourceProperties

Impostare la proprietà serviceType per specificare il tipo di oggetto.

Per DataTransfer, usare:

{
  "instanceCount": "int",
  "instanceSize": "string",
  "serviceType": "DataTransfer"
}

Per SqlDedicatedGateway, usare:

{
  "dedicatedGatewayType": "string",
  "instanceCount": "int",
  "instanceSize": "string",
  "serviceType": "SqlDedicatedGateway",
  "sqlDedicatedGatewayEndpoint": "string"
}

Per GraphAPICompute, usare:

{
  "graphApiComputeEndpoint": "string",
  "instanceCount": "int",
  "instanceSize": "string",
  "serviceType": "GraphAPICompute"
}

Per MaterializedViewsBuilder, usare:

{
  "instanceCount": "int",
  "instanceSize": "string",
  "serviceType": "MaterializedViewsBuilder"
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/services

Nome Descrizione Valore
versione dell'API Versione dell'API 'Anteprima 2026-04-01'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 50 (obbligatorio)
proprietà Risorsa di risposta dei servizi. ServiceResourceProperties
digitare Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/services'

DataTrasferimentoServizioRisorsaProprietà

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'DataTransfer' (obbligatorio)

GraphAPIComputeServiceResourceProperties

Nome Descrizione Valore
graphApiComputeEndpoint Endpoint GraphAPICompute per il servizio. string
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'GraphAPICompute' (obbligatorio)

MaterializedViewsBuilderServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'MaterializedViewsBuilder' (obbligatorio)

ServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio Imposta su 'DataTransfer' per il tipo DataTransferServiceResourceProperties. Impostato su 'SqlDedicatedGateway' per il tipo SqlDedicatedGatewayServiceResourceProperties. Impostate su 'GraphAPICompute' per il tipo GraphAPIComputeServiceResourceProperties. Imposta su 'MaterializedViewsBuilder' per il tipo MaterializedViewsBuilderServiceResourceProperties. 'Trasferimento dati'
'GraphAPICompute'
'Costruttore di visualizzazioni materializzate'
'SqlDedicatedGateway' (obbligatorio)

SqlDedicatedGatewayServiceResourceProperties

Nome Descrizione Valore
dedicatoGatewayType DedicatedGatewayType per il servizio. 'Query distribuita'
'Cache integrata'
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'SqlDedicatedGateway' (obbligatorio)
sqlDedicatedGatewayEndpoint Endpoint SqlDedicatedGateway per il servizio. string

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa databaseAccounts/services può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione del gateway dedicato SQL all'interno di un account Cosmos DB.

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    = ["*"]
}

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/services, aggiungere il file Terraform seguente al modello.

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

Oggetti ServiceResourceProperties

Impostare la proprietà serviceType per specificare il tipo di oggetto.

Per DataTransfer, usare:

{
  instanceCount = int
  instanceSize = "string"
  serviceType = "DataTransfer"
}

Per SqlDedicatedGateway, usare:

{
  dedicatedGatewayType = "string"
  instanceCount = int
  instanceSize = "string"
  serviceType = "SqlDedicatedGateway"
  sqlDedicatedGatewayEndpoint = "string"
}

Per GraphAPICompute, usare:

{
  graphApiComputeEndpoint = "string"
  instanceCount = int
  instanceSize = "string"
  serviceType = "GraphAPICompute"
}

Per MaterializedViewsBuilder, usare:

{
  instanceCount = int
  instanceSize = "string"
  serviceType = "MaterializedViewsBuilder"
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/services

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 50 (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: databaseAccounts
proprietà Risorsa di risposta dei servizi. ServiceResourceProperties
digitare Tipo di risorsa "Microsoft. DocumentDB/databaseAccounts/services@2026-04-01-anteprima"

DataTrasferimentoServizioRisorsaProprietà

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'DataTransfer' (obbligatorio)

GraphAPIComputeServiceResourceProperties

Nome Descrizione Valore
graphApiComputeEndpoint Endpoint GraphAPICompute per il servizio. string
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'GraphAPICompute' (obbligatorio)

MaterializedViewsBuilderServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'MaterializedViewsBuilder' (obbligatorio)

ServiceResourceProperties

Nome Descrizione Valore
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio Imposta su 'DataTransfer' per il tipo DataTransferServiceResourceProperties. Impostato su 'SqlDedicatedGateway' per il tipo SqlDedicatedGatewayServiceResourceProperties. Impostate su 'GraphAPICompute' per il tipo GraphAPIComputeServiceResourceProperties. Imposta su 'MaterializedViewsBuilder' per il tipo MaterializedViewsBuilderServiceResourceProperties. 'Trasferimento dati'
'GraphAPICompute'
'Costruttore di visualizzazioni materializzate'
'SqlDedicatedGateway' (obbligatorio)

SqlDedicatedGatewayServiceResourceProperties

Nome Descrizione Valore
dedicatoGatewayType DedicatedGatewayType per il servizio. 'Query distribuita'
'Cache integrata'
InstanceCount Numero di istanze per il servizio. Int

Vincoli:
Valore minimo = 0
instanceSize Tipo di istanza per il servizio. 'Cosmos.D16s'
'Cosmos.D4s'
'Cosmos.D8s'
Tipo di servizio ServiceType per il servizio. 'SqlDedicatedGateway' (obbligatorio)
sqlDedicatedGatewayEndpoint Endpoint SqlDedicatedGateway per il servizio. string