Microsoft.DocumentDB databaseAccounts

Definição de recursos do bíceps

O tipo de recurso databaseAccounts pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    capacityMode: 'string'
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      restoreWithTtlDisabled: bool
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

Para Periódica , utilize:

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

Valores de propriedade

AnalyticalStorageConfiguration

ApiProperties

Política de backup

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Política de Coerência

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Etiquetas

VirtualNetworkRule

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "capacityMode": "string",
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "restoreWithTtlDisabled": "bool",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

Para Periódica , utilize:

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

Valores de propriedade

AnalyticalStorageConfiguration

ApiProperties

Política de backup

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Política de Coerência

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Etiquetas

VirtualNetworkRule

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
API SQL da conta do Azure Cosmos DB com de armazenamento analítico	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico.
Conta do Azure Cosmos DB com de Aplicativo Web	Este modelo implanta uma conta do Azure Cosmos DB, um Plano do Serviço de Aplicativo e cria um Aplicativo Web no Plano do Serviço de Aplicativo. Ele também adiciona duas configurações de Aplicativo ao Aplicativo Web que fazem referência ao ponto de extremidade da conta do Azure Cosmos DB. Dessa forma, as soluções implantadas no Aplicativo Web podem se conectar ao ponto de extremidade da conta do Azure Cosmos DB usando essas configurações.
CI/CD usando Jenkins no do Serviço de Contêiner do Azure (AKS)	Os contêineres facilitam muito a criação e a implantação contínuas de seus aplicativos. Ao orquestrar a implantação desses contêineres usando o Kubernetes no Serviço de Contêiner do Azure, você pode obter clusters de contêineres replicáveis e gerenciáveis. Ao configurar uma compilação contínua para produzir suas imagens de contêiner e orquestração, você pode aumentar a velocidade e a confiabilidade de sua implantação.
Criar uma conta do Cosmos DB com o Microsoft Defender habilitado	Usando esse modelo ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender for Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de explorar bancos de dados em suas contas do Azure Cosmos DB. O Microsoft Defender for Azure Cosmos DB deteta possíveis injeções de SQL, agentes mal-intencionados conhecidos com base no Microsoft Threat Intelligence, padrões de acesso suspeitos e possíveis explorações do seu banco de dados por meio de identidades comprometidas ou insiders mal-intencionados.
Criar uma conta gratuita do Azure Cosmos DB	Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API SQL com um banco de dados com taxa de transferência e contêiner compartilhados.
Criar uma conta mínima do Azure Cosmos DB para a API Core (SQL)	Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) enquanto especifica apenas as propriedades mínimas de recursos necessárias.
Criar uma conta do Azure Cosmos DB sem servidor para da API SQL	Este modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL).
Criar uma conta do Azure Cosmos de toque zero e do Azure Web App	Este modelo cria uma conta do Azure Cosmos, injeta o ponto de extremidade e as chaves do Cosmos DB nas configurações do Aplicativo Web do Azure e, em seguida, implanta um aplicativo Web ASP MVC do GitHub.
Criar uma conta do Azure Cosmos para a API do MongoDB	Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para o de dimensionamento automático da API do MongoDB	Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de escala automática compartilhada e dedicada.
Criar uma conta do Azure Cosmos para a API de Tabela	Este modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência provisionada.
Criar uma conta do Azure Cosmos para a API de Tabela com de dimensionamento automático	Este modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência de escala automática.
Criar uma conta do Azure Cosmos DB para de API Cassandra	Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para a API Core (SQL)	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner com taxa de transferência com várias outras opções.
Criar uma conta do Azure Cosmos DB para a API Gremlin	Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o de dimensionamento automático da API Gremlin	Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.
Criar uma conta do Azure Cosmos DB em várias regiões	Este modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de banco de dados com uma região primária e secundária com opção de nível de consistência e tipo de failover.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
Criar uma conta do Azure Cosmos DB com um ponto de extremidade privado	Este modelo criará uma conta Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta Cosmos à rede virtual.
Criar uma conta SQL do Azure Cosmos DB com o plano de dados RBAC	Este modelo criará uma conta do SQL Cosmos, uma Definição de Função mantida nativamente e uma Atribuição de Função mantida nativamente para uma identidade do AAD.
Criar uma conta do Azure CosmosDB	Este modelo ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários
Criar conta do Azure Cosmos DB em escala automática para de API Cassandra	Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência de dimensionamento automático.
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL)	Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Criar o Azure Cosmos com a API SQL e vários contêineres	O modelo cria um contêiner Cosmos com uma API SQL e permite adicionar vários contêineres.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB	Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.
Web App com um Banco de Dados SQL, Azure Cosmos DB, Azure Search	Este modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso databaseAccounts pode ser implantado com operações direcionadas:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      capacityMode = "string"
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        restoreWithTtlDisabled = bool
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

Para Periódica , utilize:

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

Valores de propriedade

AnalyticalStorageConfiguration

ApiProperties

Política de backup

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Política de Coerência

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Etiquetas

VirtualNetworkRule