Partilhar via

Microsoft.DocumentDB databaseAccounts

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts pode ser implementado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte Bicep ao seu 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ínua, utilize:

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

Para Periodic, utilize:

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

Valores de propriedade

databaseAccounts

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

Limite de carateres: 3-44

Carateres válidos:
Letras minúsculas, números e hífenes.

Comece com letra minúscula ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
tipo Indica o tipo de conta de base de dados. Isto só pode ser definido na criação da conta de base de dados. "GlobalDocumentDB"
"MongoDB"
'Analisar'
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para criar e atualizar contas de base de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, suportada apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer cópias de segurança numa conta. BackupPolicy
capacidades Lista de capacidades do Cosmos DB para a conta Capacidade[]
capacidade O objeto que representa todas as propriedades relacionadas com a imposição de capacidade numa conta. Capacidade
conectorOffer O tipo de oferta do conector cassandra para a conta C* da base de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS da conta de base de dados do Cosmos DB. CorsPolicy[]
createMode Enum para indicar o modo de criação da conta. 'Predefinição'
"Restaurar"
customerManagedKeyStatus Indica o estado da funcionalidade Chave Gerida pelo Cliente na conta. Caso existam erros, a propriedade fornece orientações de resolução de problemas. string
databaseAccountOfferType O tipo de oferta da base de dados "Standard" (obrigatório)
defaultIdentity A identidade predefinida para aceder ao cofre de chaves utilizada em funcionalidades como chaves geridas pelo cliente. A identidade predefinida tem de ser explicitamente definida pelos utilizadores. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desativar operações de escrita em recursos de metadados (bases de dados, contentores, débito) através de chaves de conta bool
disableLocalAuth Opte ativamente por não participar na autenticação local e certifique-se de que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizar para indicar se pretende ativar a análise de armazenamento. bool
enableAutomaticFailover Ativa a ativação pós-falha automática da região de escrita no caso raro de a região estar indisponível devido a uma falha. A ativação pós-falha automática resultará numa nova região de escrita para a conta e será escolhida com base nas prioridades de ativação pós-falha configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a ativação/desativação da funcionalidade Pré-visualização da Capacidade de Expansão na conta bool
enableCassandraConnector Ativa o conector cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizar para indicar se o Escalão Gratuito está ativado. bool
enableMultipleWriteLocations Permite que a conta escreva em várias localizações bool
enablePartitionMerge Sinalizador para indicar a ativação/desativação da funcionalidade Intercalação de Partições na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se pretende ativar/desativar as regras da ACL de Rede Virtual. bool
keyVaultKeyUri O URI do cofre de chaves string
localizações Uma matriz que contém as localizações de georreplicação ativadas para a conta do Cosmos DB. Localização[] (obrigatório)
minimalTlsVersion Indica a versão mínima permitida do TLS. O valor predefinido é Tls 1.2. As APIs para Cassandra e Mongo só funcionam com o TLS 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica que serviços estão autorizados a ignorar as verificações da firewall. "AzureServices"
"Nenhum"
networkAclBypassResourceIds Uma matriz que contém os IDs de Recursos para Ignorar da Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se os pedidos da Rede Pública são permitidos "Desativado"
"Ativado"
"SecuredByPerimeter"
restoreParameters Parâmetros para indicar as informações sobre o restauro. RestoreParameters
virtualNetworkRules Lista de regras da ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nome Descrição Valor
schemaType Descreve os tipos de esquema do armazenamento analítico. "FullFidelity"
"Bem Definido"

ApiProperties

Nome Descrição Valor
serverVersion Descreve a ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

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

BackupPolicyMigrationState

Nome Descrição Valor
startTime Hora em que a migração da política de cópia de segurança foi iniciada (formato ISO-8601). string
status Descreve o estado da migração entre os tipos de política de cópia de segurança. "Concluído"
"Com falhas"
"Entrada"
"Inválido"
targetType Descreve o tipo de política de cópia de segurança de destino da migração da política de cópia de segurança. "Contínua"
"Periódico"

ContinuousModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Contínuo" (obrigatório)
continuousModeProperties Valores de configuração para cópia de segurança de modo contínuo ContinuousModeProperties

ContinuousModeProperties

Nome Descrição Valor
tier Enumerar para indicar o tipo de modo de cópia de segurança contínua "Dias Contínuos30"
'Continuous7Days'

PeriodicModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Periódico" (obrigatório)
periodicModeProperties Valores de configuração da cópia de segurança do modo periódico PeriodicModeProperties

PeriodicModeProperties

Nome Descrição Valor
backupIntervalInMinutes Um número inteiro que representa o intervalo em minutos entre duas cópias de segurança int

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um número inteiro que representa a hora (em horas) de retenção de cada cópia de segurança int

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enum para indicar o tipo de residência da cópia de segurança "Geo"
"Local"
"Zona"

Funcionalidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de débito imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de débito máximo que pode ser aprovisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não existem limites no aprovisionamento de débito. int

ConsistencyPolicy

Nome Descrição Valor
defaultConsistencyLevel O nível de consistência predefinido e as definições de configuração da conta do Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sessão"
"Forte" (obrigatório)
maxIntervalInSeconds Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa a quantidade de tempo de estagnação (em segundos) tolerada. O intervalo aceite para este valor é 5 - 86400. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa o número de pedidos obsoletos tolerados. O intervalo aceite para este valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de pedido que o domínio de origem pode especificar no pedido CORS. string
allowedMethods Os métodos (verbos de pedido HTTP) que o domínio de origem pode utilizar para um pedido CORS. string
allowedOrigins Os domínios de origem que estão autorizados a fazer um pedido contra o serviço através do CORS. cadeia (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta ao pedido CORS e expostos pelo browser ao emissor do pedido. string
maxAgeInSeconds O tempo máximo de tempo que um browser deve colocar em cache o pedido OPTIONS de pré-voo. int

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

IpAddressOrRange

Nome Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos têm de estar bem formatados e não podem ser contidos num dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, uma vez que estes não são executá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 ativação pós-falha da região. Uma prioridade de ativação pós-falha de 0 indica uma região de escrita. O valor máximo para uma prioridade de ativação pós-falha = (número total de regiões - 1). Os valores de prioridade de ativação pós-falha têm de ser exclusivos para cada uma das regiões em que a conta de base de dados existe. int

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

RestoreParameters

Nome Descrição Valor
databasesToRestore Lista de bases de dados específicas disponíveis para restauro. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bases de dados específicas do Gremlin disponíveis para restauro. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo do restauro. "PointInTime"
restoreSource O ID da conta de base de dados restabelecida a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora para a qual a conta tem de ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauro. string[]

DatabaseRestoreResource

Nome Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauro. string[]
databaseName O nome da base de dados disponível para restauro. string

GremlinDatabaseRestoreResource

Nome Descrição Valor
databaseName O nome da base de dados gremlin disponível para restauro. string
grafosNames Os nomes dos gráficos disponíveis para restauro. string[]

VirtualNetworkRule

Nome 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 de a rede virtual ter o ponto final de serviço da vnet ativado. bool

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
CI/CD com o Jenkins no Azure Container Service (AKS)

Implementar no Azure		 Os contentores tornam muito fácil criar e implementar continuamente as suas aplicações. Ao orquestrar a implementação desses contentores com o Kubernetes no Azure Container Service, pode alcançar clusters replicável e geríveis de contentores. Ao configurar uma compilação contínua para produzir as suas imagens de contentor e orquestração, pode aumentar a velocidade e fiabilidade da sua implementação.
Aplicação Web com uma Base de Dados SQL, Azure Cosmos DB, Azure Search

Implementar no Azure		 Este modelo aprovisiona uma Aplicação Web, uma Base de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.
Criar uma conta do Azure Cosmos DB para a API para Cassandra

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API para Cassandra em duas regiões com um espaço de chaves e uma tabela com débito dedicado.
Criar uma conta do Azure Cosmos DB de dimensionamento automático para a API para Cassandra

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API para Cassandra em duas regiões com um espaço de chaves e uma tabela com débito de dimensionamento automático.
Criar uma Conta do Azure CosmosDB

Implementar no Azure		 Este modelo do ARM pretende criar rapidamente uma Conta do CosmosDB com os valores mínimos necessários
Criar uma conta do Azure Cosmos DB em várias regiões

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de base de dados com uma região primária e secundária com escolha de nível de consistência e tipo de ativação pós-falha.
Criar uma conta do Azure Cosmos DB de escalão gratuito

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB de escalão gratuito para a API SQL com uma base de dados com débito e contentor partilhados.
Criar uma conta do Azure Cosmos DB para a API do Gremlin

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com uma base de dados e um gráfico com débito dedicado.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com uma base de dados e um gráfico com débito de dimensionamento automático.
Criar uma conta do Azure Cosmos para a API do MongoDB

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões com débito partilhado e dedicado com duas coleções.
Criar uma conta do Azure Cosmos para o dimensionamento automático da API do MongoDB

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões com débito de dimensionamento automático partilhado e dedicado.
Criar uma Conta do Azure Cosmos DB com um ponto final privado

Implementar no Azure		 Este modelo irá criar uma conta do Cosmos, uma rede virtual e um ponto final privado expondo a conta do Cosmos à rede virtual.
Criar uma conta do Azure Cosmos DB para a API Core (SQL)

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito com várias outras opções.
API SQL da conta do Azure Cosmos DB com arquivo analítico

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico.
Criar uma API SQL de conta do Azure Cosmos DB com o dimensionamento automático

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL)

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contentor com um procedimento armazenado, um acionador e uma função definida pelo utilizador.
Criar uma conta mínima do Azure Cosmos DB para a API Core (SQL)

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) ao especificar apenas as propriedades mínimas necessárias do recurso.
Criar o Azure Cosmos com a API SQL e vários contentores

Implementar no Azure		 O modelo cria um contentor do Cosmos com uma API SQL e permite adicionar contentores mulitple.
Criar uma Conta SQL do Azure Cosmos DB com o RBAC do plano de dados

Implementar no Azure		 Este modelo irá 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 SQL

Implementar 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

Implementar 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 débito aprovisionado.
Criar uma conta do Azure Cosmos para a API de Tabela com dimensionamento automático

Implementar 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 débito de dimensionamento automático.
Criar uma conta do Azure Cosmos sem toque e a Aplicação Web do Azure

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos, injeta o ponto final e as chaves do Cosmos DB nas definições da Aplicação Web do Azure e, em seguida, implementa uma aplicação Web ASP MVC a partir do GitHub.
Criar uma conta do Cosmos DB com o Microsoft Defender ativado

Implementar no Azure		 Com este modelo do ARM, pode implementar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB ativado. O Microsoft Defender para a Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de exploração de bases de dados nas suas contas do Azure Cosmos DB. O Microsoft Defender para a Azure Cosmos DB deteta potenciais injeções de SQL, atores incorretos conhecidos com base nas Informações sobre Ameaças da Microsoft, padrões de acesso suspeitos e potenciais explorações da sua base de dados através de identidades comprometidas ou utilizadores maliciosos.
Implementar a BD do Azure Data Explorer com a ligação do Cosmos DB

Implementar no Azure		 Implementar a BD do Azure Data Explorer com a ligação do Cosmos DB.
Conta do Azure Cosmos DB com a Aplicação Web

Implementar no Azure		 Este modelo implementa uma conta do Azure Cosmos DB, um Plano do Serviço de Aplicações e cria uma Aplicação Web no Plano do Serviço de Aplicações. Também adiciona duas definições de Aplicação à Aplicação Web que referenciam o ponto final da conta do Azure Cosmos DB. Desta forma, as soluções implementadas na Aplicação Web podem ligar-se ao ponto final da conta do Azure Cosmos DB com essas definições.

Definição de recurso do modelo arm

O tipo de recurso databaseAccounts pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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ínua, utilize:

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

Para Periodic, utilize:

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

Valores de propriedade

databaseAccounts

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

Limite de carateres: 3-44

Carateres válidos:
Letras minúsculas, números e hífenes.

Comece com letra minúscula ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
tipo Indica o tipo de conta de base de dados. Isto só pode ser definido na criação da conta de base de dados. "GlobalDocumentDB"
"MongoDB"
'Analisar'
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para criar e atualizar contas de base de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, suportada apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer cópias de segurança numa conta. BackupPolicy
capacidades Lista de capacidades do Cosmos DB para a conta Capacidade[]
capacidade O objeto que representa todas as propriedades relacionadas com a imposição de capacidade numa conta. Capacidade
connectorOffer O tipo de oferta do conector cassandra para a conta C* da base de dados do Cosmos DB. "Pequeno"
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de base de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Predefinição'
"Restaurar"
customerManagedKeyStatus Indica o estado da funcionalidade Chave Gerida pelo Cliente na conta. Caso existam erros, a propriedade fornece orientações de resolução de problemas. string
databaseAccountOfferType O tipo de oferta para a base de dados "Standard" (obrigatório)
defaultIdentity A identidade predefinida para aceder ao cofre de chaves utilizada em funcionalidades como chaves geridas pelo cliente. A identidade predefinida tem de ser explicitamente definida pelos utilizadores. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desativar operações de escrita em recursos de metadados (bases de dados, contentores, débito) através de chaves de conta bool
disableLocalAuth Opte ativamente por não participar na autenticação local e garanta que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizador para indicar se pretende ativar a análise de armazenamento. bool
enableAutomaticFailover Ativa a ativação pós-falha automática da região de escrita no caso raro de a região estar indisponível devido a uma falha. A ativação pós-falha automática resultará numa nova região de escrita para a conta e será escolhida com base nas prioridades de ativação pós-falha configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a ativação/desativação da funcionalidade Pré-visualização da Capacidade de Expansão na conta bool
enableCassandraConnector Ativa o conector do Cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizar para indicar se o Escalão Gratuito está ativado. bool
enableMultipleWriteLocations Permite que a conta escreva em várias localizações bool
enablePartitionMerge Sinalizador para indicar a ativação/desativação da funcionalidade Intercalação de Partições na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se pretende ativar/desativar as regras da ACL de Rede Virtual. bool
keyVaultKeyUri O URI do cofre de chaves string
localizações Uma matriz que contém as localizações de georreplicação ativadas para a conta do Cosmos DB. Localização[] (obrigatório)
minimalTlsVersion Indica a versão mínima de Tls permitida. O valor predefinido é Tls 1.2. As APIs para Cassandra e Mongo só funcionam com o Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica que serviços podem ignorar as verificações da firewall. "AzureServices"
"Nenhum"
networkAclBypassResourceIds Uma matriz que contém os IDs de Recursos para o Bypass da ACL de Rede para a conta do Cosmos DB. cadeia[]
publicNetworkAccess Se os pedidos da Rede Pública são permitidos "Desativado"
"Ativado"
"SecuredByPerimeter"
restoreParameters Parâmetros para indicar as informações sobre o restauro. RestoreParameters
virtualNetworkRules Lista de regras da ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nome Descrição Valor
schemaType Descreve os tipos de esquema para o armazenamento analítico. "FullFidelity"
"Bem Definido"

ApiProperties

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

BackupPolicy

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

BackupPolicyMigrationState

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

ContinuousModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Contínuo" (obrigatório)
continuousModeProperties Valores de configuração da cópia de segurança do modo contínuo ContinuousModeProperties

ContinuousModeProperties

Nome Descrição Valor
tier Enum para indicar o tipo de modo de cópia de segurança contínua 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Periódico" (obrigatório)
periodicModeProperties Valores de configuração da cópia de segurança do modo periódico PeriodicModeProperties

PeriodicModeProperties

Nome Descrição Valor
backupIntervalInMinutes Um número inteiro que representa o intervalo em minutos entre duas cópias de segurança int

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um número inteiro que representa a hora (em horas) de retenção de cada cópia de segurança int

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enum para indicar o tipo de residência da cópia de segurança "Geo"
"Local"
"Zona"

Funcionalidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de débito imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de débito máximo que pode ser aprovisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não existem limites no aprovisionamento de débito. int

ConsistencyPolicy

Nome Descrição Valor
defaultConsistencyLevel O nível de consistência predefinido e as definições de configuração da conta do Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sessão"
"Forte" (obrigatório)
maxIntervalInSeconds Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa a quantidade de tempo de estagnação (em segundos) tolerada. O intervalo aceite para este valor é 5 - 86400. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa o número de pedidos obsoletos tolerados. O intervalo aceite para este valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de pedido que o domínio de origem pode especificar no pedido CORS. string
allowedMethods Os métodos (verbos de pedido HTTP) que o domínio de origem pode utilizar para um pedido CORS. string
allowedOrigins Os domínios de origem que estão autorizados a fazer um pedido contra o serviço através do CORS. cadeia (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta ao pedido CORS e expostos pelo browser ao emissor do pedido. string
maxAgeInSeconds O tempo máximo que um browser deve colocar em cache o pedido OPTIONS de verificação prévia. int

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

IpAddressOrRange

Nome Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos têm de estar bem formatados e não podem estar contidos num dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, uma vez que não são executá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 ativação pós-falha da região. Uma prioridade de ativação pós-falha de 0 indica uma região de escrita. O valor máximo para uma prioridade de ativação pós-falha = (número total de regiões - 1). Os valores de prioridade de ativação pós-falha têm de ser exclusivos para cada uma das regiões em que a conta de base de dados existe. int

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

RestoreParameters

Nome Descrição Valor
databasesToRestore Lista de bases de dados específicas disponíveis para restauro. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bases de dados específicas do Gremlin disponíveis para restauro. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo do restauro. "PointInTime"
restoreSource O ID da conta de base de dados restabelecida a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora para a qual a conta tem de ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauro. string[]

DatabaseRestoreResource

Nome Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauro. string[]
databaseName O nome da base de dados disponível para restauro. string

GremlinDatabaseRestoreResource

Nome Descrição Valor
databaseName O nome da base de dados gremlin disponível para restauro. string
grafosNames Os nomes dos gráficos disponíveis para restauro. string[]

VirtualNetworkRule

Nome 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 de a rede virtual ter o ponto final de serviço da vnet ativado. bool

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
CI/CD com o Jenkins no Azure Container Service (AKS)

Implementar no Azure		 Os contentores tornam muito fácil criar e implementar continuamente as suas aplicações. Ao orquestrar a implementação desses contentores com o Kubernetes no Azure Container Service, pode alcançar clusters replicável e geríveis de contentores. Ao configurar uma compilação contínua para produzir as suas imagens de contentor e orquestração, pode aumentar a velocidade e fiabilidade da sua implementação.
Aplicação Web com uma Base de Dados SQL, Azure Cosmos DB, Azure Search

Implementar no Azure		 Este modelo aprovisiona uma Aplicação Web, uma Base de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.
Criar uma conta do Azure Cosmos DB para a API para Cassandra

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API para Cassandra em duas regiões com um espaço de chaves e uma tabela com débito dedicado.
Criar uma conta do Azure Cosmos DB de dimensionamento automático para a API para Cassandra

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API para Cassandra em duas regiões com um espaço de chaves e uma tabela com débito de dimensionamento automático.
Criar uma Conta do Azure CosmosDB

Implementar no Azure		 Este modelo do ARM pretende criar rapidamente uma Conta do CosmosDB com os valores mínimos necessários
Criar uma conta do Azure Cosmos DB em várias regiões

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de base de dados com uma região primária e secundária com escolha de nível de consistência e tipo de ativação pós-falha.
Criar uma conta do Azure Cosmos DB de camada livre

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB de escalão livre para a API SQL com uma base de dados com débito e contentor partilhados.
Criar uma conta do Azure Cosmos DB para a API do Gremlin

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com uma base de dados e um gráfico com débito dedicado.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com uma base de dados e um gráfico com débito de dimensionamento automático.
Criar uma conta do Azure Cosmos para a API do MongoDB

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões com débito partilhado e dedicado com duas coleções.
Criar uma conta do Azure Cosmos para o dimensionamento automático da API do MongoDB

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões através do débito de dimensionamento automático partilhado e dedicado.
Criar uma Conta do Azure Cosmos DB com um ponto final privado

Implementar no Azure		 Este modelo irá criar uma conta do Cosmos, uma rede virtual e um ponto final privado que expõe a conta do Cosmos à rede virtual.
Criar uma conta do Azure Cosmos DB para a API Core (SQL)

Implementar no Azure		 Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor com débito com várias outras opções.
API SQL da conta do Azure Cosmos DB com arquivo analítico

Implementar no Azure		 Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico.
Criar uma API SQL de conta do Azure Cosmos DB com dimensionamento automático

Implementar no Azure		 Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor com débito de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL)

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contentor com um procedimento armazenado, acionador e função definida pelo utilizador.
Criar uma conta mínima do Azure Cosmos DB para a API Core (SQL)

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL), ao mesmo tempo que especifica apenas as propriedades de recursos mínimas necessárias.
Criar o Azure Cosmos com a API SQL e vários contentores

Implementar no Azure		 O modelo cria um contentor do Cosmos com uma API SQL e permite adicionar contentores mulitple.
Criar uma Conta SQL do Azure Cosmos DB com o RBAC do plano de dados

Implementar no Azure		 Este modelo irá criar uma conta do SQL Cosmos, uma Definição de Função nativamente mantida e uma Atribuição de Função nativamente mantida para uma identidade do AAD.
Criar uma conta do Azure Cosmos DB sem servidor para a API SQL

Implementar 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 Tabelas

Implementar 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 débito aprovisionado.
Criar uma conta do Azure Cosmos para a API de Tabelas com dimensionamento automático

Implementar 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 débito de dimensionamento automático.
Criar uma conta do Azure Cosmos sem toque e a Aplicação Web do Azure

Implementar no Azure		 Este modelo cria uma conta do Azure Cosmos, injeta o ponto final e as chaves do Cosmos DB nas definições da Aplicação Web do Azure e, em seguida, implementa uma aplicação Web ASP MVC a partir do GitHub.
Criar uma conta do Cosmos DB com o Microsoft Defender ativado

Implementar no Azure		 Com este modelo do ARM, pode implementar uma conta do Azure Cosmos DB com o Microsoft Defender para o Azure Cosmos DB ativado. O Microsoft Defender para o Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de exploração de bases de dados nas suas contas do Azure Cosmos DB. O Microsoft Defender para o Azure Cosmos DB deteta potenciais injeções de SQL, atores incorretos conhecidos com base no Microsoft Threat Intelligence, padrões de acesso suspeitos e potenciais explorações da sua base de dados através de identidades comprometidas ou utilizadores maliciosos.
Implementar a BD do Azure Data Explorer com a ligação do Cosmos DB

Implementar no Azure		 Implementar a BD do Azure Data Explorer com a ligação do Cosmos DB.
Conta do Azure Cosmos DB com a Aplicação Web

Implementar no Azure		 Este modelo implementa uma conta do Azure Cosmos DB, um Plano do Serviço de Aplicações e cria uma Aplicação Web no Plano do Serviço de Aplicações. Também adiciona duas definições de Aplicação à Aplicação Web que referenciam o ponto final da conta do Azure Cosmos DB. Desta forma, as soluções implementadas na Aplicação Web podem ligar-se ao ponto final da conta do Azure Cosmos DB com essas definições.

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso databaseAccounts pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-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 tipo para especificar o tipo de objeto.

Para Contínua, utilize:

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

Para Periodic, utilize:

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

Valores de propriedade

databaseAccounts

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

Limite de carateres: 3-44

Carateres válidos:
Letras minúsculas, números e hífenes.

Comece com letra minúscula ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização do grupo de recursos ao qual o recurso pertence. string
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas.
tipo Indica o tipo de conta de base de dados. Isto só pode ser definido na criação da conta de base de dados. "GlobalDocumentDB"
"MongoDB"
"Analisar"
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para criar e atualizar contas de base de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Matriz de IDs de identidade de utilizador.

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. AnalyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, suportada apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer cópias de segurança numa conta. BackupPolicy
capacidades Lista de capacidades do Cosmos DB para a conta Capacidade[]
capacidade O objeto que representa todas as propriedades relacionadas com a imposição de capacidade numa conta. Capacidade
conectorOffer O tipo de oferta do conector cassandra para a conta C* da base de dados do Cosmos DB. "Pequeno"
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS da conta de base de dados do Cosmos DB. CorsPolicy[]
createMode Enum para indicar o modo de criação da conta. "Predefinição"
"Restaurar"
customerManagedKeyStatus Indica o estado da funcionalidade Chave Gerida pelo Cliente na conta. Caso existam erros, a propriedade fornece orientações de resolução de problemas. string
databaseAccountOfferType O tipo de oferta da base de dados "Standard" (obrigatório)
defaultIdentity A identidade predefinida para aceder ao cofre de chaves utilizada em funcionalidades como chaves geridas pelo cliente. A identidade predefinida tem de ser explicitamente definida pelos utilizadores. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. string
disableKeyBasedMetadataWriteAccess Desativar operações de escrita em recursos de metadados (bases de dados, contentores, débito) através de chaves de conta bool
disableLocalAuth Opte ativamente por não participar na autenticação local e garanta que apenas o MSI e o AAD podem ser utilizados exclusivamente para autenticação. bool
enableAnalyticalStorage Sinalizador para indicar se pretende ativar a análise de armazenamento. bool
enableAutomaticFailover Ativa a ativação pós-falha automática da região de escrita no caso raro de a região estar indisponível devido a uma falha. A ativação pós-falha automática resultará numa nova região de escrita para a conta e será escolhida com base nas prioridades de ativação pós-falha configuradas para a conta. bool
enableBurstCapacity Sinalizador para indicar a ativação/desativação da funcionalidade Pré-visualização da Capacidade de Expansão na conta bool
enableCassandraConnector Ativa o conector do Cassandra na conta C* do Cosmos DB bool
enableFreeTier Sinalizador para indicar se o Escalão Gratuito está ativado. bool
enableMultipleWriteLocations Permite que a conta escreva em várias localizações bool
enablePartitionMerge Sinalizador para indicar a ativação/desativação da funcionalidade Intercalação de Partições na conta bool
ipRules Lista de IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Sinalizador para indicar se pretende ativar/desativar as regras da ACL de Rede Virtual. bool
keyVaultKeyUri O URI do cofre de chaves string
localizações Uma matriz que contém as localizações de georreplicação ativadas para a conta do Cosmos DB. Localização[] (obrigatório)
minimalTlsVersion Indica a versão mínima permitida do TLS. O valor predefinido é Tls 1.2. As APIs para Cassandra e Mongo só funcionam com o TLS 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass Indica que serviços estão autorizados a ignorar as verificações da firewall. "AzureServices"
"Nenhum"
networkAclBypassResourceIds Uma matriz que contém os IDs de Recursos para Ignorar da Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se os pedidos da Rede Pública são permitidos "Desativado"
"Ativado"
"SecuredByPerimeter"
restoreParameters Parâmetros para indicar as informações sobre o restauro. RestoreParameters
virtualNetworkRules Lista de regras da ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nome Descrição Valor
schemaType Descreve os tipos de esquema do armazenamento analítico. "FullFidelity"
"Bem Definido"

ApiProperties

Nome Descrição Valor
serverVersion Descreve a ServerVersion de uma conta do MongoDB. "3.2"
"3.6"
"4.0"
"4.2"
"5.0"
"6.0"

BackupPolicy

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

BackupPolicyMigrationState

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

ContinuousModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Contínuo" (obrigatório)
continuousModeProperties Valores de configuração da cópia de segurança do modo contínuo ContinuousModeProperties

ContinuousModeProperties

Nome Descrição Valor
tier Enum para indicar o tipo de modo de cópia de segurança contínua "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

Nome Descrição Valor
tipo Descreve o modo de cópias de segurança. "Periódico" (obrigatório)
periodicModeProperties Valores de configuração da cópia de segurança do modo periódico PeriodicModeProperties

PeriodicModeProperties

Nome Descrição Valor
backupIntervalInMinutes Um número inteiro que representa o intervalo em minutos entre duas cópias de segurança int

Restrições:
Valor mínimo = 0
backupRetentionIntervalInHours Um número inteiro que representa a hora (em horas) de retenção de cada cópia de segurança int

Restrições:
Valor mínimo = 0
backupStorageRedundancy Enum para indicar o tipo de residência da cópia de segurança "Geo"
"Local"
"Zona"

Funcionalidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de débito imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de débito máximo que pode ser aprovisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não existem limites no aprovisionamento de débito. int

ConsistencyPolicy

Nome Descrição Valor
defaultConsistencyLevel O nível de consistência predefinido e as definições de configuração da conta do Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sessão"
"Forte" (obrigatório)
maxIntervalInSeconds Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa a quantidade de tempo de estagnação (em segundos) tolerada. O intervalo aceite para este valor é 5 - 86400. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando utilizado com o nível de consistência Estagnação Vinculada, este valor representa o número de pedidos obsoletos tolerados. O intervalo aceite para este valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy está definido como "BoundedStaleness". int

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de pedido que o domínio de origem pode especificar no pedido CORS. string
allowedMethods Os métodos (verbos de pedido HTTP) que o domínio de origem pode utilizar para um pedido CORS. string
allowedOrigins Os domínios de origem que estão autorizados a fazer um pedido contra o serviço através do CORS. cadeia (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta ao pedido CORS e expostos pelo browser ao emissor do pedido. string
maxAgeInSeconds O tempo máximo de tempo que um browser deve colocar em cache o pedido OPTIONS de pré-voo. int

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

IpAddressOrRange

Nome Descrição Valor
ipAddressOrRange Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos têm de estar bem formatados e não podem ser contidos num dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, uma vez que estes não são executá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 ativação pós-falha da região. Uma prioridade de ativação pós-falha de 0 indica uma região de escrita. O valor máximo para uma prioridade de ativação pós-falha = (número total de regiões - 1). Os valores de prioridade de ativação pós-falha têm de ser exclusivos para cada uma das regiões em que a conta de base de dados existe. int

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

RestoreParameters

Nome Descrição Valor
databasesToRestore Lista de bases de dados específicas disponíveis para restauro. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista de bases de dados gremlin específicas disponíveis para restauro. GremlinDatabaseRestoreResource[]
restoreMode Descreve o modo de restauro. "PointInTime"
restoreSource O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora para a qual a conta tem de ser restaurada (formato ISO-8601). string
tablesToRestore Lista de tabelas específicas disponíveis para restauro. cadeia[]

DatabaseRestoreResource

Nome Descrição Valor
collectionNames Os nomes das coleções disponíveis para restauro. cadeia[]
databaseName O nome da base de dados disponível para restauro. string

GremlinDatabaseRestoreResource

Nome Descrição Valor
databaseName O nome da base de dados gremlin disponível para restauro. string
graphNames Os nomes dos gráficos disponíveis para restauro. cadeia[]

VirtualNetworkRule

Nome 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 de a rede virtual ter o ponto final de serviço da vnet ativado. bool