Partilhar via


Banco de dados Microsoft.DocumentDBContas 2021-01-15

Definição de recursos do bíceps

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 do recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-01-15' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    databaseAccountOfferType: 'Standard'
    disableKeyBasedMetadataWriteAccess: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  type: 'Continuous'
}

Para Periódica , utilize:

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

Valores de propriedade

ApiProperties

Designação Descrição Valor
serverVersion Descreve o ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'

Política de backup

Designação Descrição Valor
tipo Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. 'Contínuo'
«Periódico» (obrigatório)

Capacidade

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

Política de Coerência

Designação Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. 'Estagnação limitada'
'ConsistentPrefix'
'Eventual'
'Sessão'
'Forte' (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Bounded Staleness, esse valor representa a quantidade de tempo de atraso (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 usado com o nível de consistência Bounded Staleness, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito 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

ContinuousModeBackupPolicy

Designação Descrição Valor
tipo Descreve o modo de backups. 'Contínuo' (obrigatório)

CorsPolicy

Designação Descrição Valor
allowedCabeçalhos Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. string
allowedOrigens Os domínios de origem que têm permissão para fazer uma solicitação contra o serviço via CORS. string (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. string
maxAgeInSeconds O tempo máximo que um navegador deve armazenar em cache a solicitação OPTIONS de comprovação. Int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Designação Descrição Valor
apiPropriedades Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB. ApiProperties
backupPolítica O objeto que representa a política para fazer backups em uma conta. BackupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta Capacidade []
conectorOferta O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
coerênciaPolítica A política de consistência para a conta do Cosmos DB. ConsistênciaPolítica
CORS A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
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
enableAnalyticalStorage Sinalizador para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Permite 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
habilitarCassandraConnector Ativa o conector cassandra na conta C* do Cosmos DB Bool
habilitarFreeTier Sinalizador para indicar se o Nível Livre está habilitado. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
ipRegras 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. Localização[] (obrigatório)
networkAclBypass Indica quais serviços têm permissão para ignorar as verificações de firewall. 'AzureServices'
'Nenhuma'
networkAclBypassResourceIds Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desativado'
'Habilitado'
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule []

IpAddressOrRange

Designação 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, uma vez que 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

Designação 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 esta região é ou não uma região AvailabilityZone Bool
localizaçãoNome O nome da região. string

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
tipo 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'
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
propriedades Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

PeriodicModeBackupPolicy

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

PeriodicModeProperties

Designação 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

Etiquetas

Designação Descrição Valor

VirtualNetworkRule

Designação 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 do serviço vnet habilitado. Bool

Exemplos de início rápido

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

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

Definição de recurso de modelo ARM

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 do recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2021-01-15",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  "type": "Continuous"
}

Para Periódica , utilize:

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

Valores de propriedade

ApiProperties

Designação Descrição Valor
serverVersion Descreve o ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'

Política de backup

Designação Descrição Valor
tipo Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. 'Contínuo'
«Periódico» (obrigatório)

Capacidade

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

Política de Coerência

Designação Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. 'Estagnação limitada'
'ConsistentPrefix'
'Eventual'
'Sessão'
'Forte' (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Bounded Staleness, esse valor representa a quantidade de tempo de atraso (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 usado com o nível de consistência Bounded Staleness, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito 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

ContinuousModeBackupPolicy

Designação Descrição Valor
tipo Descreve o modo de backups. 'Contínuo' (obrigatório)

CorsPolicy

Designação Descrição Valor
allowedCabeçalhos Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. string
allowedOrigens Os domínios de origem que têm permissão para fazer uma solicitação contra o serviço via CORS. string (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. string
maxAgeInSeconds O tempo máximo que um navegador deve armazenar em cache a solicitação OPTIONS de comprovação. Int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Designação Descrição Valor
apiPropriedades Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB. ApiProperties
backupPolítica O objeto que representa a política para fazer backups em uma conta. BackupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta Capacidade []
conectorOferta O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
coerênciaPolítica A política de consistência para a conta do Cosmos DB. ConsistênciaPolítica
CORS A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
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
enableAnalyticalStorage Sinalizador para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Permite 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
habilitarCassandraConnector Ativa o conector cassandra na conta C* do Cosmos DB Bool
habilitarFreeTier Sinalizador para indicar se o Nível Livre está habilitado. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
ipRegras 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. Localização[] (obrigatório)
networkAclBypass Indica quais serviços têm permissão para ignorar as verificações de firewall. 'AzureServices'
'Nenhuma'
networkAclBypassResourceIds Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desativado'
'Habilitado'
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule []

IpAddressOrRange

Designação 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, uma vez que 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

Designação 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 esta região é ou não uma região AvailabilityZone Bool
localizaçãoNome O nome da região. string

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Designação Descrição Valor
apiVersion A versão api '2021-01-15'
identidade Identidade do recurso. ManagedServiceIdentity
tipo 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'
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
propriedades Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts'

PeriodicModeBackupPolicy

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

PeriodicModeProperties

Designação 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

Etiquetas

Designação Descrição Valor

VirtualNetworkRule

Designação 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 do serviço 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
API SQL da conta do Azure Cosmos DB com de armazenamento analítico

Implantar no Azure
Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico.
Conta do Azure Cosmos DB com de Aplicativo Web

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.
CI/CD usando Jenkins no do Serviço de Contêiner do Azure (AKS)

Implantar no Azure
Os contêineres facilitam muito a criação e a implantação contínuas de seus aplicativos. Ao orquestrar a implantação desses contêineres usando o Kubernetes no Serviço de Contêiner do Azure, você pode obter clusters de contêineres replicáveis e gerenciáveis. Ao configurar uma compilação contínua para produzir suas imagens de contêiner e orquestração, você pode aumentar a velocidade e a confiabilidade de sua implantação.
Criar uma conta do Cosmos DB com o Microsoft Defender habilitado

Implantar no Azure
Usando esse modelo ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender for Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de explorar bancos de dados em suas contas do Azure Cosmos DB. O Microsoft Defender for Azure Cosmos DB deteta possíveis injeções de SQL, agentes mal-intencionados conhecidos com base no Microsoft Threat Intelligence, padrões de acesso suspeitos e possíveis explorações do seu banco de dados por meio de identidades comprometidas ou insiders mal-intencionados.
Criar uma conta gratuita do Azure Cosmos DB

Implantar no Azure
Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API SQL com um banco de dados com taxa de transferência e contêiner compartilhados.
Criar uma conta mínima do Azure Cosmos DB para a API Core (SQL)

Implantar no Azure
Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) enquanto especifica apenas as propriedades mínimas de recursos necessárias.
Criar uma conta do Azure Cosmos DB sem servidor para da API SQL

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 de toque zero e do Azure Web App

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, em seguida, implanta um aplicativo Web ASP MVC do GitHub.
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 o de 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 escala automática compartilhada e dedicada.
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 de 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 escala automática.
Criar uma conta do Azure Cosmos DB para de API Cassandra

Implantar no Azure
Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para a API Core (SQL)

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

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

Implantar no Azure
Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.
Criar uma conta do Azure Cosmos DB em várias regiões

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 opção de nível de consistência e tipo de failover.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático

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

Implantar no Azure
Este modelo criará uma conta Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta Cosmos à rede virtual.
Criar uma conta SQL do Azure Cosmos DB com o plano de dados RBAC

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 CosmosDB

Implantar no Azure
Este modelo ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários
Criar conta do Azure Cosmos DB em escala automática para de API Cassandra

Implantar no Azure
Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência de dimensionamento automático.
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL)

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

Implantar no Azure
O modelo cria um contêiner Cosmos com uma API SQL e permite adicionar vários contêineres.
Cria um aplicativo de microsserviços Dapr usando o Container Apps

Implantar no Azure
Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner

Implantar no Azure
Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB

Implantar no Azure
Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.
Web App com um Banco de Dados SQL, Azure Cosmos DB, Azure Search

Implantar no Azure
Este modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights.

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2021-01-15"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      databaseAccountOfferType = "Standard"
      disableKeyBasedMetadataWriteAccess = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  type = "Continuous"
}

Para Periódica , utilize:

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

Valores de propriedade

ApiProperties

Designação Descrição Valor
serverVersion Descreve o ServerVersion de uma conta do MongoDB. '3.2'
'3.6'
'4.0'

Política de backup

Designação Descrição Valor
tipo Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. 'Contínuo'
«Periódico» (obrigatório)

Capacidade

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

Política de Coerência

Designação Descrição Valor
defaultConsistencyLevel O nível de consistência padrão e as definições de configuração da conta do Cosmos DB. 'Estagnação limitada'
'ConsistentPrefix'
'Eventual'
'Sessão'
'Forte' (obrigatório)
maxIntervalInSeconds Quando usado com o nível de consistência Bounded Staleness, esse valor representa a quantidade de tempo de atraso (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 usado com o nível de consistência Bounded Staleness, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito 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

ContinuousModeBackupPolicy

Designação Descrição Valor
tipo Descreve o modo de backups. 'Contínuo' (obrigatório)

CorsPolicy

Designação Descrição Valor
allowedCabeçalhos Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. string
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. string
allowedOrigens Os domínios de origem que têm permissão para fazer uma solicitação contra o serviço via CORS. string (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. string
maxAgeInSeconds O tempo máximo que um navegador deve armazenar em cache a solicitação OPTIONS de comprovação. Int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Designação Descrição Valor
apiPropriedades Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB. ApiProperties
backupPolítica O objeto que representa a política para fazer backups em uma conta. BackupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta Capacidade []
conectorOferta O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
coerênciaPolítica A política de consistência para a conta do Cosmos DB. ConsistênciaPolítica
CORS A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
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
enableAnalyticalStorage Sinalizador para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Permite 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
habilitarCassandraConnector Ativa o conector cassandra na conta C* do Cosmos DB Bool
habilitarFreeTier Sinalizador para indicar se o Nível Livre está habilitado. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
ipRegras 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. Localização[] (obrigatório)
networkAclBypass Indica quais serviços têm permissão para ignorar as verificações de firewall. 'AzureServices'
'Nenhuma'
networkAclBypassResourceIds Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desativado'
'Habilitado'
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule []

IpAddressOrRange

Designação 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, uma vez que 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

Designação 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 esta região é ou não uma região AvailabilityZone Bool
localizaçãoNome O nome da região. string

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
tipo 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'
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 3
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
propriedades Propriedades para criar e atualizar contas de banco de dados do Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts@2021-01-15"

PeriodicModeBackupPolicy

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

PeriodicModeProperties

Designação 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

Etiquetas

Designação Descrição Valor

VirtualNetworkRule

Designação 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 do serviço vnet habilitado. Bool