Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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
    }
    connectorOffer: 'Small'
    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'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: 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: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para Contínuo, use:

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

Para Periodic, use:

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

Valores de propriedade

databaseAccounts

Name Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 44

Caracteres válidos:
Letras minúsculas, números e hifens.

Comece com letra minúscula ou número.

O nome do recurso deve ser exclusivo no Azure.
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
kind Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados. 'GlobalDocumentDB'
'MongoDB'
'Analisar'
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Name Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. BackupPolicy
funcionalidades Lista de recursos do Cosmos DB para a conta Funcionalidade[]
ALOCADA O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. Capacidade
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência para a conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Padrão'
'Restore'
customerManagedKeyStatus Indica o status do recurso Chave Gerenciada pelo Cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. string
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta bool
disableLocalAuth Recusar a autenticação local e garantir que apenas MSI e AAD possam ser usados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizador para indicar se deseja habilitar a análise de armazenamento. bool
enableAutomaticFailover Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a habilitação/desabilitação do recurso de Visualização de Capacidade de Intermitência na conta bool
enableCassandraConnector Habilita o conector do Cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizador para indicar se a Camada Gratuita está habilitada. bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais bool
enablePartitionMerge Sinalizador para indicar a habilitação/desabilitação do recurso de Mesclagem de Partição na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. bool
keyVaultKeyUri O URI do cofre de chaves string
Locais Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB. Localização[] (obrigatório)
minimalTlsVersion Indica a versão mínima permitida de TLS. O valor padrão é Tls 1.2. As APIs do Cassandra e do Mongo funcionam apenas com o Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quais serviços têm permissão para ignorar verificações de firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Uma matriz que contém as IDs de recurso para bypass de acl de rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desabilitado'
'Enabled'
'SecuredByPerimeter'
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Name Descrição Valor
Schematype Descreve os tipos de esquema para armazenamento analítico. 'FullFidelity'
'WellDefined'

ApiProperties

Name Descrição Valor
Versão do servidor Descreve o ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Name Descrição Valor
migrationState O objeto que representa o estado da migração entre as políticas de backup. BackupPolicyMigrationState
tipo Definir o tipo de objeto Contínuo
Periódico (obrigatório)

BackupPolicyMigrationState

Name Descrição Valor
startTime Hora em que a migração da política de backup foi iniciada (formato ISO-8601). string
status Descreve o status da migração entre tipos de política de backup. 'Concluído'
'Falha'
'InProgress'
'Inválido'
targetType Descreve o tipo de política de backup de destino da migração da política de backup. 'Contínuo'
'Periodic'

ContinuousModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. 'Contínuo' (obrigatório)
continuousModeProperties Valores de configuração para backup de modo contínuo ContinuousModeProperties

ContinuousModeProperties

Name Descrição Valor
Camada Enumeração para indicar o tipo de modo de backup contínuo 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. 'Periodic' (obrigatório)
periodicModeProperties Valores de configuração para backup de modo periódico PeriodicModeProperties

PeriodicModeProperties

Name Descrição Valor
backupIntervalInMinutes Um inteiro que representa o intervalo em minutos entre dois backups INT

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um inteiro que representa o tempo (em horas) em que cada backup é retido INT

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enumeração para indicar o tipo de residência de backup 'Geo'
'Local'
'Zone'

Funcionalidade

Name Descrição Valor
name Nome da funcionalidade do Cosmos DB. Por exemplo, "name": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin". string

Capacity

Name Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionada nessa conta como 2000. Um totalThroughputLimit de -1 indica que não há limites para o provisionamento da taxa de transferência. INT

ConsistencyPolicy

Name Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Sessão'
'Strong' (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Desatualização Limitada, esse valor representa a quantidade de tempo de desatualização (em segundos) tolerada. O intervalo aceito para esse valor é de 5 a 86400. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é de 1 a 2,147,483,647. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

CorsPolicy

Name Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação de CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que podem usar o domínio de origem para uma solicitação CORS. string
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados em resposta à solicitação de CORS e expostos pelo navegador para o emissor da solicitação. string
maxAgeInSeconds A quantidade máxima de tempo pela qual um navegador deve armazenar em cache a solicitação OPTIONS de simulação. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

IpAddressOrRange

Name Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem estar bem formatados e não podem estar contidos em um dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, pois eles não são aplicáveis pelo filtro de endereço IP. Exemplo de entradas válidas: "23.40.210.245" ou "23.40.210.0/8". string

Localização

Nome Descrição Valor
failoverPriority A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões em que a conta de banco de dados existe. INT

Restrições:
Valor mínimo = 0
isZoneRedundant Sinalizador para indicar se essa região é ou não uma região availabilityZone bool
locationName O nome da região. string

RestoreParameters

Name Descrição Valor
databasesToRestore Lista de bancos de dados específicos disponíveis para restauração. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bancos de dados gremlin específicos disponíveis para restauração. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo da restauração. 'PointInTime'
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora em que a conta precisa ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauração. string[]

DatabaseRestoreResource

Name Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauração. string[]
databaseName O nome do banco de dados disponível para restauração. string

GremlinDatabaseRestoreResource

Name Descrição Valor
databaseName O nome do banco de dados gremlin disponível para restauração. string
graphNames Os nomes dos grafos disponíveis para restauração. string[]

VirtualNetworkRule

Name Descrição Valor
id ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade de serviço de vnet habilitado. bool

Modelos de início rápido

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

Modelo Descrição
CI/CD usando Jenkins no AKS (Serviço de Contêiner do Azure)

Implantar no Azure		 Os contêineres facilitam muito a criação e a implantação contínua 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 replicáveis e gerenciáveis de contêineres. Ao configurar um build contínuo para produzir suas imagens de contêiner e orquestração, você pode aumentar a velocidade e a confiabilidade da implantação.
Aplicativo Web com um Banco de Dados SQL, Azure Cosmos DB, Azure Search

Implantar no Azure		 Esse modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.
Criar uma conta do Azure Cosmos DB para a API do Cassandra

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência dedicada.
Criar uma conta de dimensionamento automático do Azure Cosmos DB para a API do Cassandra

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência de dimensionamento automático.
Criar uma conta do Azure CosmosDB

Implantar no Azure		 Este modelo do ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários
Criar uma conta do Azure Cosmos DB em várias regiões

Implantar no Azure		 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 a opção de nível de consistência e tipo de failover.
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure		 Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para a API do SQL com um banco de dados com taxa de transferência compartilhada e contêiner.
Criar uma conta do Azure Cosmos DB para a API do Gremlin

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para dimensionamento automático da API do Gremlin

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência de dimensionamento automático.
Criar uma conta do Azure Cosmos para a API do MongoDB

Implantar no Azure		 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 dimensionamento automático da API do MongoDB

Implantar no Azure		 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 dimensionamento automático compartilhada e dedicada.
Criar uma conta do Azure Cosmos DB com um ponto de extremidade privado

Implantar no Azure		 Esse modelo criará uma conta do Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta do Cosmos à rede virtual.
Criar uma conta do Azure Cosmos DB para a API do Core (SQL)

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções.
API do SQL da conta do Azure Cosmos DB com repositório analítico

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico.
Criar uma API de SQL da conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL)

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, um gatilho e uma função definida pelo usuário.
Criar uma conta mínima do Azure Cosmos DB para a API do Core (SQL)

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) enquanto especifica apenas as propriedades mínimas de recurso necessárias.
Criar o Azure Cosmos com a API do SQL e vários contêineres

Implantar no Azure		 O modelo cria um contêiner do Cosmos com uma API do SQL e permite adicionar contêineres mulitple.
Criar uma conta SQL do Azure Cosmos DB com o RBAC do plano de dados

Implantar no Azure		 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 Cosmos DB sem servidor para a API do SQL

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL).
Criar uma conta do Azure Cosmos para a API de Tabela

Implantar no Azure		 Esse 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 dimensionamento automático

Implantar no Azure		 Esse 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 dimensionamento automático.
Criar uma conta do Azure Cosmos com toque zero e um Aplicativo Web do Azure

Implantar no Azure		 Esse 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 implanta um aplicativo Web ASP MVC do GitHub.
Criar uma conta do Cosmos DB com o Microsoft Defender habilitado

Implantar no Azure		 Usando esse modelo do ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender para Azure Cosmos DB é uma camada de segurança nativa do Azure que detecta qualquer tentativa de explorar bancos de dados nas suas contas do Azure Cosmos DB. O Microsoft Defender para Azure Cosmos DB detecta possíveis injeções de SQL, atores mal-intencionados conhecidos com base na Inteligência contra Ameaças da Microsoft, padrões de acesso suspeitos e possíveis explorações do banco de dados por meio de identidades comprometidas ou pessoas mal-intencionadas.
Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

Implantar no Azure		 Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.
Conta do Azure Cosmos DB com Aplicativo Web

Implantar no Azure		 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.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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"
    },
    "connectorOffer": "Small",
    "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",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "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": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para Contínuo, use:

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

Para Periodic, use:

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

Valores de propriedade

databaseAccounts

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts'
apiVersion A versão da API do recurso '2024-05-15'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 44

Caracteres válidos:
Letras minúsculas, números e hifens.

Comece com letra minúscula ou número.

O nome do recurso deve ser exclusivo no Azure.
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
kind Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados. 'GlobalDocumentDB'
'MongoDB'
'Analisar'
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Name Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. BackupPolicy
funcionalidades Lista de recursos do Cosmos DB para a conta Funcionalidade[]
ALOCADA O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. Capacidade
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência para a conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Padrão'
'Restore'
customerManagedKeyStatus Indica o status do recurso Chave Gerenciada pelo Cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. string
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta bool
disableLocalAuth Recusar a autenticação local e garantir que apenas MSI e AAD possam ser usados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizador para indicar se deseja habilitar a análise de armazenamento. bool
enableAutomaticFailover Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a habilitação/desabilitação do recurso de Visualização de Capacidade de Intermitência na conta bool
enableCassandraConnector Habilita o conector do Cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizador para indicar se a Camada Gratuita está habilitada. bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais bool
enablePartitionMerge Sinalizador para indicar a habilitação/desabilitação do recurso de Mesclagem de Partição na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. bool
keyVaultKeyUri O URI do cofre de chaves string
Locais Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB. Localização[] (obrigatório)
minimalTlsVersion Indica a versão mínima permitida de TLS. O valor padrão é Tls 1.2. As APIs do Cassandra e do Mongo funcionam apenas com o Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quais serviços têm permissão para ignorar verificações de firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Uma matriz que contém as IDs de recurso para bypass de acl de rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desabilitado'
'Enabled'
'SecuredByPerimeter'
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Name Descrição Valor
Schematype Descreve os tipos de esquema para armazenamento analítico. 'FullFidelity'
'WellDefined'

ApiProperties

Name Descrição Valor
Versão do servidor Descreve o ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Name Descrição Valor
migrationState O objeto que representa o estado da migração entre as políticas de backup. BackupPolicyMigrationState
tipo Definir o tipo de objeto Contínuo
Periódico (obrigatório)

BackupPolicyMigrationState

Name Descrição Valor
startTime Hora em que a migração da política de backup foi iniciada (formato ISO-8601). string
status Descreve o status da migração entre tipos de política de backup. 'Concluído'
'Falha'
'InProgress'
'Inválido'
targetType Descreve o tipo de política de backup de destino da migração da política de backup. 'Contínuo'
'Periodic'

ContinuousModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. 'Contínuo' (obrigatório)
continuousModeProperties Valores de configuração para backup de modo contínuo ContinuousModeProperties

ContinuousModeProperties

Name Descrição Valor
Camada Enumeração para indicar o tipo de modo de backup contínuo 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. 'Periodic' (obrigatório)
periodicModeProperties Valores de configuração para backup de modo periódico PeriodicModeProperties

PeriodicModeProperties

Name Descrição Valor
backupIntervalInMinutes Um inteiro que representa o intervalo em minutos entre dois backups INT

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um inteiro que representa o tempo (em horas) em que cada backup é retido INT

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enumeração para indicar o tipo de residência de backup 'Geo'
'Local'
'Zone'

Funcionalidade

Name Descrição Valor
name Nome da funcionalidade do Cosmos DB. Por exemplo, "name": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin". string

Capacity

Name Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionada nessa conta como 2000. Um totalThroughputLimit de -1 indica que não há limites para o provisionamento da taxa de transferência. INT

ConsistencyPolicy

Name Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Sessão'
'Strong' (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Desatualização Limitada, esse valor representa a quantidade de tempo de desatualização (em segundos) tolerada. O intervalo aceito para esse valor é de 5 a 86400. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é de 1 a 2,147,483,647. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

CorsPolicy

Name Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação de CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que podem usar o domínio de origem para uma solicitação CORS. string
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados em resposta à solicitação de CORS e expostos pelo navegador para o emissor da solicitação. string
maxAgeInSeconds A quantidade máxima de tempo pela qual um navegador deve armazenar em cache a solicitação OPTIONS de simulação. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

IpAddressOrRange

Name Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem estar bem formatados e não podem estar contidos em um dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, pois eles não são aplicáveis pelo filtro de endereço IP. Exemplo de entradas válidas: "23.40.210.245" ou "23.40.210.0/8". string

Localização

Nome Descrição Valor
failoverPriority A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões em que a conta de banco de dados existe. INT

Restrições:
Valor mínimo = 0
isZoneRedundant Sinalizador para indicar se essa região é ou não uma região availabilityZone bool
locationName O nome da região. string

RestoreParameters

Name Descrição Valor
databasesToRestore Lista de bancos de dados específicos disponíveis para restauração. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bancos de dados gremlin específicos disponíveis para restauração. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo da restauração. 'PointInTime'
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora em que a conta precisa ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauração. string[]

DatabaseRestoreResource

Name Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauração. string[]
databaseName O nome do banco de dados disponível para restauração. string

GremlinDatabaseRestoreResource

Name Descrição Valor
databaseName O nome do banco de dados gremlin disponível para restauração. string
graphNames Os nomes dos grafos disponíveis para restauração. string[]

VirtualNetworkRule

Name Descrição Valor
id ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade de serviço de vnet habilitado. bool

Modelos de início rápido

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

Modelo Descrição
CI/CD usando Jenkins no AKS (Serviço de Contêiner do Azure)

Implantar no Azure		 Os contêineres facilitam muito a criação e a implantação contínua 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 replicáveis e gerenciáveis de contêineres. Ao configurar um build contínuo para produzir suas imagens de contêiner e orquestração, você pode aumentar a velocidade e a confiabilidade da implantação.
Aplicativo Web com um Banco de Dados SQL, Azure Cosmos DB, Azure Search

Implantar no Azure		 Esse modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.
Criar uma conta do Azure Cosmos DB para a API do Cassandra

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência dedicada.
Criar conta do Azure Cosmos DB de dimensionamento automático para a API do Cassandra

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência de dimensionamento automático.
Criar uma conta do Azure CosmosDB

Implantar no Azure		 Este modelo do ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários
Criar uma conta do Azure Cosmos DB em várias regiões

Implantar no Azure		 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 escolha de nível de consistência e tipo de failover.
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência compartilhada e contêiner.
Criar uma conta do Azure Cosmos DB para a API do Gremlin

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para dimensionamento automático da API do Gremlin

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência de dimensionamento automático.
Criar uma conta do Azure Cosmos para a API do MongoDB

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para dimensionamento automático da API do MongoDB

Implantar no Azure		 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 dimensionamento automático compartilhada e dedicada.
Criar uma conta do Azure Cosmos DB com um ponto de extremidade privado

Implantar no Azure		 Esse modelo criará uma conta do Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta do Cosmos à rede virtual.
Criar uma conta do Azure Cosmos DB para a API do Core (SQL)

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções.
API do SQL da conta do Azure Cosmos DB com repositório analítico

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico.
Criar uma API de SQL de conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure		 Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core)

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Criar uma conta mínima do Azure Cosmos DB para a API do Core (SQL)

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos DB para a API Core (SQL), especificando apenas as propriedades mínimas de recurso necessárias.
Criar o Azure Cosmos com a API do SQL e vários contêineres

Implantar no Azure		 O modelo cria um contêiner do Cosmos com uma API do SQL e permite adicionar contêineres mulitple.
Criar uma conta SQL do Azure Cosmos DB com o RBAC do plano de dados

Implantar no Azure		 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 Cosmos DB sem servidor para a API do SQL

Implantar no Azure		 Este modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL).
Criar uma conta do Azure Cosmos para a API de Tabela

Implantar no Azure		 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 dimensionamento automático

Implantar no Azure		 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 dimensionamento automático.
Criar uma conta do Azure Cosmos com toque zero e um Aplicativo Web do Azure

Implantar no Azure		 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 implanta um aplicativo Web ASP MVC do GitHub.
Criar uma conta do Cosmos DB com o Microsoft Defender habilitado

Implantar no Azure		 Usando esse modelo do ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender para Azure Cosmos DB é uma camada de segurança nativa do Azure que detecta qualquer tentativa de explorar bancos de dados nas suas contas do Azure Cosmos DB. O Microsoft Defender para Azure Cosmos DB detecta possíveis injeções de SQL, atores inválidos conhecidos com base na Inteligência contra Ameaças da Microsoft, padrões de acesso suspeitos e possíveis explorações do banco de dados por meio de identidades comprometidas ou participantes mal-intencionados.
Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

Implantar no Azure		 Implante o BD do Azure Data Explorer com a conexão do Cosmos DB.
Conta do Azure Cosmos DB com Aplicativo Web

Implantar no Azure		 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.

Definição de recurso do 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 de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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
      }
      connectorOffer = "Small"
      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"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = 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 = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para Contínuo, use:

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

Para Periodic, use:

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

Valores de propriedade

databaseAccounts

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 44

Caracteres válidos:
Letras minúsculas, números e hifens.

Comece com letra minúscula ou número.

O nome do recurso deve ser exclusivo no Azure.
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
kind Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados. "GlobalDocumentDB"
"MongoDB"
"Analisar"
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de IDs de identidade do usuário.

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Name Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. BackupPolicy
funcionalidades Lista de recursos do Cosmos DB para a conta Capability[]
ALOCADA O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. Capacidade
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. "Pequeno"
consistencyPolicy A política de consistência para a conta do Cosmos DB. ConsistencyPolicy
cors A política cors para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumeração para indicar o modo de criação da conta. "Padrão"
"Restaurar"
customerManagedKeyStatus Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. string
databaseAccountOfferType O tipo de oferta para o banco de dados "Standard" (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta bool
disableLocalAuth Recusar a autenticação local e garantir que apenas o MSI e o AAD possam ser usados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizador para indicar se a análise de armazenamento deve ser habilitada. bool
enableAutomaticFailover Habilita o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a habilitação/desabilitação do recurso de Visualização da Capacidade de Intermitência na conta bool
enableCassandraConnector Habilita o conector do Cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizador para indicar se a Camada Gratuita está habilitada. bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais bool
enablePartitionMerge Sinalizador para indicar a habilitação/desabilitação do recurso de Mesclagem de Partições na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. bool
keyVaultKeyUri O URI do cofre de chaves string
Locais Uma matriz que contém os locais de replicação geográfica habilitados para a conta do Cosmos DB. Location[] (obrigatório)
minimalTlsVersion Indica a versão mínima permitida do TLS. O valor padrão é Tls 1.2. As APIs do Cassandra e do Mongo só funcionam com o Tls 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass Indica quais serviços têm permissão para ignorar verificações de firewall. "AzureServices"
"None"
networkAclBypassResourceIds Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas "Desabilitado"
"Habilitado"
"SecuredByPerimeter"
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de rede virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Name Descrição Valor
Schematype Descreve os tipos de esquema para armazenamento analítico. "FullFidelity"
"WellDefined"

ApiProperties

Name Descrição Valor
Versão do servidor Descreve o ServerVersion de uma conta do MongoDB. "3.2"
"3.6"
"4.0"
"4.2"
"5.0"
"6.0"

BackupPolicy

Name Descrição Valor
migrationState O objeto que representa o estado da migração entre as políticas de backup. BackupPolicyMigrationState
tipo Definir o tipo de objeto Contínuo
Periódico (obrigatório)

BackupPolicyMigrationState

Name Descrição Valor
startTime Hora em que a migração da política de backup foi iniciada (formato ISO-8601). string
status Descreve o status da migração entre tipos de política de backup. "Concluído"
"Falha"
"InProgress"
"Inválido"
targetType Descreve o tipo de política de backup de destino da migração da política de backup. "Contínuo"
"Periódico"

ContinuousModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. "Contínuo" (obrigatório)
continuousModeProperties Valores de configuração para backup de modo contínuo ContinuousModeProperties

ContinuousModeProperties

Name Descrição Valor
Camada Enumeração para indicar o tipo de modo de backup contínuo "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

Name Descrição Valor
tipo Descreve o modo de backups. "Periódico" (obrigatório)
periodicModeProperties Valores de configuração para backup de modo periódico PeriodicModeProperties

PeriodicModeProperties

Name Descrição Valor
backupIntervalInMinutes Um inteiro que representa o intervalo em minutos entre dois backups INT

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um inteiro que representa o tempo (em horas) em que cada backup é retido INT

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enumeração para indicar o tipo de residência de backup "Geo"
"Local"
"Zona"

Funcionalidade

Name Descrição Valor
name Nome da funcionalidade do Cosmos DB. Por exemplo, "name": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin". string

Capacity

Name Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionada nessa conta como 2000. Um totalThroughputLimit de -1 indica que não há limites para o provisionamento da taxa de transferência. INT

ConsistencyPolicy

Name Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sessão"
"Forte" (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Desatualização Limitada, esse valor representa a quantidade de tempo de desatualização (em segundos) tolerada. O intervalo aceito para esse valor é de 5 a 86400. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é de 1 a 2,147,483,647. Obrigatório quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

CorsPolicy

Name Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação de CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que podem usar o domínio de origem para uma solicitação CORS. string
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados em resposta à solicitação de CORS e expostos pelo navegador para o emissor da solicitação. string
maxAgeInSeconds A quantidade máxima de tempo pela qual um navegador deve armazenar em cache a solicitação OPTIONS de simulação. INT

Restrições:
Valor mínimo = 1
Valor máximo = 2147483647

IpAddressOrRange

Name Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem ser bem formatados e não podem ser contidos em um dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, pois eles não são aplicáveis pelo filtro de endereço IP. Exemplo de entradas válidas: "23.40.210.245" ou "23.40.210.0/8". string

Localização

Nome Descrição Valor
failoverPriority A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe. INT

Restrições:
Valor mínimo = 0
isZoneRedundant Sinalizador para indicar se essa região é ou não uma região availabilityZone bool
locationName O nome da região. string

RestoreParameters

Name Descrição Valor
databasesToRestore Lista de bancos de dados específicos disponíveis para restauração. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bancos de dados gremlin específicos disponíveis para restauração. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo da restauração. "PointInTime"
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauração. string[]

DatabaseRestoreResource

Name Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauração. string[]
databaseName O nome do banco de dados disponível para restauração. string

GremlinDatabaseRestoreResource

Name Descrição Valor
databaseName O nome do banco de dados gremlin disponível para restauração. string
graphNames Os nomes dos grafos disponíveis para restauração. string[]

VirtualNetworkRule

Name Descrição Valor
id ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade de serviço de vnet habilitado. bool