Banco de dados Microsoft.DocumentDBContas 2023-09-15
- Últimas
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Definição de recursos do bíceps
O tipo de recurso databaseAccounts pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte Bíceps ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-09-15' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
capacity: {
totalThroughputLimit: int
}
connectorOffer: 'string'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
customerManagedKeyStatus: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
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: 'string'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
tablesToRestore: [
'string'
]
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
tags: {
{customized property}: 'string'
}
}
Objetos BackupPolicy
Defina a propriedade type para especificar o tipo de objeto.
Para contínuo, utilize:
{
continuousModeProperties: {
tier: 'string'
}
type: 'Continuous'
}
Para Periódica , utilize:
{
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
type: 'Periodic'
}
Valores de propriedade
AnalyticalStorageConfiguration
Designação | Descrição | Valor |
---|---|---|
schemaType | Descreve os tipos de esquema para armazenamento analítico. | 'Fidelidade total' 'Bem definido' |
ApiProperties
Designação | Descrição | Valor |
---|---|---|
serverVersion | Descreve o ServerVersion de uma conta do MongoDB. | '3.2' '3.6' '4.0' '4.2' |
Política de backup
Designação | Descrição | Valor |
---|---|---|
migrationState | O objeto que representa o estado da migração entre as políticas de backup. | BackupPolicyMigrationState |
tipo | Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. | 'Contínuo' «Periódico» (obrigatório) |
BackupPolicyMigrationState
Designação | Descrição | Valor |
---|---|---|
startTime | Momento em que a migração da política de backup foi iniciada (formato ISO-8601). | string |
Situação | Descreve o status da migração entre tipos de política de backup. | 'Concluído' 'Falhou' 'Em andamento' 'Inválido' |
Tipo de destino | Descreve o tipo de política de backup de destino da migração da política de backup. | 'Contínuo' 'Periódico' |
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 |
Capacidade
Designação | Descrição | Valor |
---|---|---|
totalThroughputLimit | O limite de taxa de transferência total imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não há limites no provisionamento da taxa de transferência. | Int Restrições: Valor mínimo = -1 |
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 |
---|---|---|
continuousModeProperties | Valores de configuração para backup em modo contínuo | ContinuousModeProperties |
tipo | Descreve o modo de backups. | 'Contínuo' (obrigatório) |
ContinuousModeProperties
Designação | Descrição | Valor |
---|---|---|
nível | Enum para indicar o tipo de modo de backup contínuo | 'Contínuo30 dias' 'Contínuo7Dias' |
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 |
---|---|---|
analyticalStorageConfiguration | Propriedades específicas de armazenamento analítico. | AnalyticalStorageConfiguration |
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 [] |
capacidade | O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma 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[] |
createMode | Enum para indicar o modo de criação da conta. | 'Inadimplência' 'Restaurar' |
customerManagedKeyStatus | Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas. | 'Acesso à chave gerenciada pelo cliente configurada confirmado.' "O acesso à sua conta está atualmente revogado porque as regras de acesso estão a bloquear pedidos de saída para o serviço Azure Key Vault; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016).' "O acesso à sua conta está atualmente revogado porque a conta do Azure Cosmos DB tem uma identidade padrão indefinida; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015).' 'O acesso à sua conta está atualmente revogado porque o URI da chave do cofre da conta do Azure Cosmos DB não segue o formato esperado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue obter o token de autenticação do AAD para a identidade padrão da conta; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue encapsular ou desembrulhar a chave; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005).' 'O acesso à sua conta está atualmente revogado porque o nome DNS do Cofre de Chaves do Azure especificado pela propriedade keyvaultkeyuri da conta não pôde ser resolvido; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009).' "O acesso à sua conta está atualmente revogado porque o correspondente Azure Key Vault não foi encontrado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017).' "O acesso à sua conta está atualmente revogado porque a chave correspondente não foi encontrada no Cofre de Chaves especificado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003).' "O acesso à sua conta está atualmente revogado porque a identidade padrão atual não tem mais permissão para a chave do Cofre da Chave associada; Para mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002).' "O acesso à sua conta está atualmente revogado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide' |
databaseAccountOfferType | O tipo de oferta para o banco de dados | 'Standard' (obrigatório) |
defaultIdentity | A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. | string |
disableKeyBasedMetadataWriteAccess | Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta | Bool |
disableLocalAuth | Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação. | 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 |
enableBurstCapacity | Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na 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 |
enablePartitionMerge | Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta | 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) |
minimalTlsVersion | Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
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' 'SecuredByPerimeter' |
restoreParameters | Parâmetros para indicar as informações sobre a restauração. | RestoreParameters |
virtualNetworkRules | Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
collectionNames | Os nomes das coleções disponíveis para restauração. | string[] |
Nome do banco de dados | O nome do banco de dados disponível para restauração. | string |
GremlinDatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
Nome do banco de dados | O nome do banco de dados gremlin disponível para restauração. | string |
graphNames [en] | Os nomes dos gráficos disponíveis para restauração. | string[] |
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
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 |
backupStorageRedundancy | Enum para indicar o tipo de residência de backup | 'Geo' 'Local' 'Zona' |
RestoreParameters
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:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2023-09-15",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"capacity": {
"totalThroughputLimit": "int"
},
"connectorOffer": "string",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"customerManagedKeyStatus": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"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": "string",
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"tablesToRestore": [ "string" ]
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Objetos BackupPolicy
Defina a propriedade type para especificar o tipo de objeto.
Para contínuo, utilize:
{
"continuousModeProperties": {
"tier": "string"
},
"type": "Continuous"
}
Para Periódica , utilize:
{
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
},
"type": "Periodic"
}
Valores de propriedade
AnalyticalStorageConfiguration
Designação | Descrição | Valor |
---|---|---|
schemaType | Descreve os tipos de esquema para armazenamento analítico. | 'Fidelidade total' 'Bem definido' |
ApiProperties
Designação | Descrição | Valor |
---|---|---|
serverVersion | Descreve o ServerVersion de uma conta do MongoDB. | '3.2' '3.6' '4.0' '4.2' |
Política de backup
Designação | Descrição | Valor |
---|---|---|
migrationState | O objeto que representa o estado da migração entre as políticas de backup. | BackupPolicyMigrationState |
tipo | Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. | 'Contínuo' «Periódico» (obrigatório) |
BackupPolicyMigrationState
Designação | Descrição | Valor |
---|---|---|
startTime | Momento em que a migração da política de backup foi iniciada (formato ISO-8601). | string |
Situação | Descreve o status da migração entre tipos de política de backup. | 'Concluído' 'Falhou' 'Em andamento' 'Inválido' |
Tipo de destino | Descreve o tipo de política de backup de destino da migração da política de backup. | 'Contínuo' 'Periódico' |
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 |
Capacidade
Designação | Descrição | Valor |
---|---|---|
totalThroughputLimit | O limite de taxa de transferência total imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não há limites no provisionamento da taxa de transferência. | Int Restrições: Valor mínimo = -1 |
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 |
---|---|---|
continuousModeProperties | Valores de configuração para backup em modo contínuo | ContinuousModeProperties |
tipo | Descreve o modo de backups. | 'Contínuo' (obrigatório) |
ContinuousModeProperties
Designação | Descrição | Valor |
---|---|---|
nível | Enum para indicar o tipo de modo de backup contínuo | 'Contínuo30 dias' 'Contínuo7Dias' |
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 |
---|---|---|
analyticalStorageConfiguration | Propriedades específicas de armazenamento analítico. | AnalyticalStorageConfiguration |
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 [] |
capacidade | O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma 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[] |
createMode | Enum para indicar o modo de criação da conta. | 'Inadimplência' 'Restaurar' |
customerManagedKeyStatus | Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas. | 'Acesso à chave gerenciada pelo cliente configurada confirmado.' "O acesso à sua conta está atualmente revogado porque as regras de acesso estão a bloquear pedidos de saída para o serviço Azure Key Vault; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016).' "O acesso à sua conta está atualmente revogado porque a conta do Azure Cosmos DB tem uma identidade padrão indefinida; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015).' 'O acesso à sua conta está atualmente revogado porque o URI da chave do cofre da conta do Azure Cosmos DB não segue o formato esperado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue obter o token de autenticação do AAD para a identidade padrão da conta; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue encapsular ou desembrulhar a chave; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005).' 'O acesso à sua conta está atualmente revogado porque o nome DNS do Cofre de Chaves do Azure especificado pela propriedade keyvaultkeyuri da conta não pôde ser resolvido; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009).' "O acesso à sua conta está atualmente revogado porque o correspondente Azure Key Vault não foi encontrado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017).' "O acesso à sua conta está atualmente revogado porque a chave correspondente não foi encontrada no Cofre de Chaves especificado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003).' "O acesso à sua conta está atualmente revogado porque a identidade padrão atual não tem mais permissão para a chave do Cofre da Chave associada; Para mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002).' "O acesso à sua conta está atualmente revogado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide' |
databaseAccountOfferType | O tipo de oferta para o banco de dados | 'Standard' (obrigatório) |
defaultIdentity | A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. | string |
disableKeyBasedMetadataWriteAccess | Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta | Bool |
disableLocalAuth | Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação. | 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 |
enableBurstCapacity | Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na 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 |
enablePartitionMerge | Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta | 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) |
minimalTlsVersion | Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
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' 'SecuredByPerimeter' |
restoreParameters | Parâmetros para indicar as informações sobre a restauração. | RestoreParameters |
virtualNetworkRules | Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
collectionNames | Os nomes das coleções disponíveis para restauração. | string[] |
Nome do banco de dados | O nome do banco de dados disponível para restauração. | string |
GremlinDatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
Nome do banco de dados | O nome do banco de dados gremlin disponível para restauração. | string |
graphNames [en] | Os nomes dos gráficos disponíveis para restauração. | string[] |
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
ManagedServiceIdentityUserAssignedIdentities
Designação | Descrição | Valor |
---|
Microsoft.DocumentDB/databaseAccounts
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2023-09-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 |
backupStorageRedundancy | Enum para indicar o tipo de residência de backup | 'Geo' 'Local' 'Zona' |
RestoreParameters
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 |
Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico. |
Conta do Azure Cosmos DB com de Aplicativo Web |
Este modelo implanta uma conta do Azure Cosmos DB, um Plano do Serviço de Aplicativo e cria um Aplicativo Web no Plano do Serviço de Aplicativo. Ele também adiciona duas configurações de Aplicativo ao Aplicativo Web que fazem referência ao ponto de extremidade da conta do Azure Cosmos DB. Dessa forma, as soluções implantadas no Aplicativo Web podem se conectar ao ponto de extremidade da conta do Azure Cosmos DB usando essas configurações. |
CI/CD usando Jenkins no do Serviço de Contêiner do Azure (AKS) |
Os contêineres facilitam muito a criação e a implantação contínuas de seus aplicativos. Ao orquestrar a implantação desses contêineres usando o Kubernetes no Serviço de Contêiner do Azure, você pode obter clusters de contêineres replicáveis e gerenciáveis. Ao configurar uma compilação contínua para produzir suas imagens de contêiner e orquestração, você pode aumentar a velocidade e a confiabilidade de sua implantação. |
Criar uma conta do Cosmos DB com o Microsoft Defender habilitado |
Usando esse modelo ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender for Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de explorar bancos de dados em suas contas do Azure Cosmos DB. O Microsoft Defender for Azure Cosmos DB deteta possíveis injeções de SQL, agentes mal-intencionados conhecidos com base no Microsoft Threat Intelligence, padrões de acesso suspeitos e possíveis explorações do seu banco de dados por meio de identidades comprometidas ou insiders mal-intencionados. |
Criar uma conta gratuita do Azure Cosmos DB |
Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API SQL com um banco de dados com taxa de transferência e contêiner compartilhados. |
Criar uma conta mínima do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) enquanto especifica apenas as propriedades mínimas de recursos necessárias. |
Criar uma conta do Azure Cosmos DB sem servidor para da API SQL |
Este modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL). |
Criar uma conta do Azure Cosmos de toque zero e do Azure Web App |
Este modelo cria uma conta do Azure Cosmos, injeta o ponto de extremidade e as chaves do Cosmos DB nas configurações do Aplicativo Web do Azure e, em seguida, implanta um aplicativo Web ASP MVC do GitHub. |
Criar uma conta do Azure Cosmos para a API do MongoDB |
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções. |
Criar uma conta do Azure Cosmos para o de dimensionamento automático da API do MongoDB |
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de escala automática compartilhada e dedicada. |
Criar uma conta do Azure Cosmos para a API de Tabela |
Este modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência provisionada. |
Criar uma conta do Azure Cosmos para a API de Tabela com de dimensionamento automático |
Este modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência de escala automática. |
Criar uma conta do Azure Cosmos DB para de API Cassandra |
Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência dedicada. |
Criar uma conta do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner com taxa de transferência com várias outras opções. |
Criar uma conta do Azure Cosmos DB para a API Gremlin |
Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando taxa de transferência dedicada. |
Criar uma conta do Azure Cosmos DB para o de dimensionamento automático da API Gremlin |
Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática. |
Criar uma conta do Azure Cosmos DB em várias regiões |
Este modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de banco de dados com uma região primária e secundária com opção de nível de consistência e tipo de failover. |
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático |
Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner com taxa de transferência de dimensionamento automático com várias outras opções. |
Criar uma conta do Azure Cosmos DB com um ponto de extremidade privado |
Este modelo criará uma conta Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta Cosmos à rede virtual. |
Criar uma conta SQL do Azure Cosmos DB com o plano de dados RBAC |
Este modelo criará uma conta do SQL Cosmos, uma Definição de Função mantida nativamente e uma Atribuição de Função mantida nativamente para uma identidade do AAD. |
Criar uma conta do Azure CosmosDB |
Este modelo ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários |
Criar conta do Azure Cosmos DB em escala automática para de API Cassandra |
Este modelo cria uma conta do Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chave e uma tabela com taxa de transferência de dimensionamento automático. |
Criar procedimentos armazenados da API do Azure Cosmos DB Core (SQL) |
Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário. |
Criar o Azure Cosmos com a API SQL e vários contêineres |
O modelo cria um contêiner Cosmos com uma API SQL e permite adicionar vários contêineres. |
Cria um aplicativo de microsserviços Dapr usando o Container Apps |
Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner. |
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner |
Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner. |
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB |
Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB. |
Web App com um Banco de Dados SQL, Azure Cosmos DB, Azure Search |
Este modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso databaseAccounts pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2023-09-15"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
capacity = {
totalThroughputLimit = int
}
connectorOffer = "string"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
customerManagedKeyStatus = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
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 = "string"
restoreSource = "string"
restoreTimestampInUtc = "string"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
Objetos BackupPolicy
Defina a propriedade type para especificar o tipo de objeto.
Para contínuo, utilize:
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
Para Periódica , utilize:
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
Valores de propriedade
AnalyticalStorageConfiguration
Designação | Descrição | Valor |
---|---|---|
schemaType | Descreve os tipos de esquema para armazenamento analítico. | 'Fidelidade total' 'Bem definido' |
ApiProperties
Designação | Descrição | Valor |
---|---|---|
serverVersion | Descreve o ServerVersion de uma conta do MongoDB. | '3.2' '3.6' '4.0' '4.2' |
Política de backup
Designação | Descrição | Valor |
---|---|---|
migrationState | O objeto que representa o estado da migração entre as políticas de backup. | BackupPolicyMigrationState |
tipo | Defina como 'Contínuo' para o tipo ContinuousModeBackupPolicy. Defina como 'Periodic' para o tipo PeriodicModeBackupPolicy. | 'Contínuo' «Periódico» (obrigatório) |
BackupPolicyMigrationState
Designação | Descrição | Valor |
---|---|---|
startTime | Momento em que a migração da política de backup foi iniciada (formato ISO-8601). | string |
Situação | Descreve o status da migração entre tipos de política de backup. | 'Concluído' 'Falhou' 'Em andamento' 'Inválido' |
Tipo de destino | Descreve o tipo de política de backup de destino da migração da política de backup. | 'Contínuo' 'Periódico' |
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 |
Capacidade
Designação | Descrição | Valor |
---|---|---|
totalThroughputLimit | O limite de taxa de transferência total imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não há limites no provisionamento da taxa de transferência. | Int Restrições: Valor mínimo = -1 |
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 |
---|---|---|
continuousModeProperties | Valores de configuração para backup em modo contínuo | ContinuousModeProperties |
tipo | Descreve o modo de backups. | 'Contínuo' (obrigatório) |
ContinuousModeProperties
Designação | Descrição | Valor |
---|---|---|
nível | Enum para indicar o tipo de modo de backup contínuo | 'Contínuo30 dias' 'Contínuo7Dias' |
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 |
---|---|---|
analyticalStorageConfiguration | Propriedades específicas de armazenamento analítico. | AnalyticalStorageConfiguration |
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 [] |
capacidade | O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma 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[] |
createMode | Enum para indicar o modo de criação da conta. | 'Inadimplência' 'Restaurar' |
customerManagedKeyStatus | Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas. | 'Acesso à chave gerenciada pelo cliente configurada confirmado.' "O acesso à sua conta está atualmente revogado porque as regras de acesso estão a bloquear pedidos de saída para o serviço Azure Key Vault; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016).' "O acesso à sua conta está atualmente revogado porque a conta do Azure Cosmos DB tem uma identidade padrão indefinida; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015).' 'O acesso à sua conta está atualmente revogado porque o URI da chave do cofre da conta do Azure Cosmos DB não segue o formato esperado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue obter o token de autenticação do AAD para a identidade padrão da conta; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000).' "O acesso à sua conta está atualmente revogado porque o serviço Azure Cosmos DB não consegue encapsular ou desembrulhar a chave; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005).' 'O acesso à sua conta está atualmente revogado porque o nome DNS do Cofre de Chaves do Azure especificado pela propriedade keyvaultkeyuri da conta não pôde ser resolvido; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009).' "O acesso à sua conta está atualmente revogado porque o correspondente Azure Key Vault não foi encontrado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017).' "O acesso à sua conta está atualmente revogado porque a chave correspondente não foi encontrada no Cofre de Chaves especificado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003).' "O acesso à sua conta está atualmente revogado porque a identidade padrão atual não tem mais permissão para a chave do Cofre da Chave associada; Para mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002).' "O acesso à sua conta está atualmente revogado; Para obter mais detalhes sobre este erro e como restaurar o acesso à sua conta, visite https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide' |
databaseAccountOfferType | O tipo de oferta para o banco de dados | 'Standard' (obrigatório) |
defaultIdentity | A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. | string |
disableKeyBasedMetadataWriteAccess | Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta | Bool |
disableLocalAuth | Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação. | 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 |
enableBurstCapacity | Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na 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 |
enablePartitionMerge | Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta | 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) |
minimalTlsVersion | Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
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' 'SecuredByPerimeter' |
restoreParameters | Parâmetros para indicar as informações sobre a restauração. | RestoreParameters |
virtualNetworkRules | Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
collectionNames | Os nomes das coleções disponíveis para restauração. | string[] |
Nome do banco de dados | O nome do banco de dados disponível para restauração. | string |
GremlinDatabaseRestoreResource
Designação | Descrição | Valor |
---|---|---|
Nome do banco de dados | O nome do banco de dados gremlin disponível para restauração. | string |
graphNames [en] | Os nomes dos gráficos disponíveis para restauração. | string[] |
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
ManagedServiceIdentityUserAssignedIdentities
Designação | Descrição | Valor |
---|
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 |
backupStorageRedundancy | Enum para indicar o tipo de residência de backup | 'Geo' 'Local' 'Zona' |
RestoreParameters
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 |