Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts 2023-11-15

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-11-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 tipo para especificar o tipo de objeto.

Para contínua, use:

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

Para Periódica, use:

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

Valores de propriedade

AnalyticalStorageConfiguration

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

ApiProperties

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

BackupPolicy

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

BackupPolicyMigrationState

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

Capacidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto na conta. Um totalthroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para 2000. Um totalThroughputLimit de -1 não indica limites de provisionamento de taxa de transferência. int

Restrições:
Valor mínimo = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

ConsistencyPolicy

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

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para esse valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. int

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

ContinuousModeBackupPolicy

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

ContinuousModeProperties

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. corda
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. corda
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. corda
maxAgeInSeconds O tempo máximo de tempo que um navegador deve armazenar em cache a solicitação OPTIONS de pré-vôo. int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. analyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. backupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta de funcionalidade do []
capacidade O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. de capacidade do
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Padrão'
'Restaurar'
customerManagedKeyStatus Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. corda
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. corda
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 Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação. Bool
enableAnalyticalStorage Sinalizar para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. Bool
enableBurstCapacity Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta Bool
enableCassandraConnector Habilita o conector do Cassandra na conta do C* do Cosmos DB Bool
enableFreeTier Sinalizar para indicar se a Camada Livre está habilitada. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
enablePartitionMerge Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta Bool
ipRules Lista de IpRules. IpAddressOrRange []
isVirtualNetworkFilterEnabled Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. Bool
keyVaultKeyUri O URI do cofre de chaves corda
Locais Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB. Local[] (obrigatório)
minimalTlsVersion Indica a versão mínima de TLS permitida. 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 verificações de firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desabilitado'
'Habilitado'
'SecuredByPerimeter'
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

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

IpAddressOrRange

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

Localização

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

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Nome 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. corda
nome O nome do recurso corda

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)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

PeriodicModeBackupPolicy

Nome 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

Nome 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 é mantido int

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

RestoreParameters

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

Tags

Nome Descrição Valor

VirtualNetworkRule

Nome Descrição Valor
id ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. corda
ignoreMissingVNetServiceEndpoint Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade de serviço da 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 do SQL da conta do Azure Cosmos DB com o repositório analítico Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico.
conta do Azure Cosmos DB com o aplicativo Web Esse 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 do ARM, você pode implantar uma conta do Azure Cosmos DB com o Microsoft Defender para Azure Cosmos DB habilitado. O Microsoft Defender para Azure Cosmos DB é uma camada de segurança nativa do Azure que detecta tentativas de explorar bancos de dados em suas contas do Azure Cosmos DB. O Microsoft Defender para Azure Cosmos DB detecta possíveis injeções de SQL, maus atores conhecidos com base na Inteligência contra Ameaças da Microsoft, padrões de acesso suspeitos e potenciais explorações do banco de dados por meio de identidades comprometidas ou insiders mal-intencionados.
Criar uma conta do Azure Cosmos DB de camada gratuita Esse modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência e contêiner compartilhados.
Criar uma conta mínima do Azure Cosmos DB para a API do Core (SQL) Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL), especificando apenas as propriedades mínimas de recurso necessárias.
criar uma conta do Azure Cosmos DB sem servidor para a API do SQL Esse modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL).
Criar uma conta do Azure Cosmos com toque zero e um aplicativo Web do Azure Esse modelo cria uma conta do Azure Cosmos, injeta o ponto de extremidade e as chaves do Cosmos DB nas configurações do Aplicativo Web do Azure e implanta um aplicativo Web ASP MVC do GitHub.
Criar uma conta do Azure Cosmos para a API do MongoDB Esse 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 dimensionamento automático da API do MongoDB Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de dimensionamento automático compartilhada e dedicada.
criar uma conta do Azure Cosmos para a API de Tabela Esse modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência provisionada.
Criar uma conta do Azure Cosmos para a API de Tabela com de dimensionamento automático Esse modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência de dimensionamento automático.
Criar uma conta do Azure Cosmos DB para a API do Cassandra Esse modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para a API do Core (SQL) Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções.
Criar uma conta do Azure Cosmos DB para a API do Gremlin Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência de dimensionamento automático.
Criar uma conta do Azure Cosmos DB em várias regiões Esse modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de banco de dados com uma região primária e secundária com escolha de nível de consistência e tipo de failover.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
criar uma conta do Azure Cosmos DB com um ponto de extremidade privado Esse modelo criará uma conta do Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta do Cosmos à rede virtual.
criar uma conta SQL do Azure Cosmos DB com o RBAC do plano de dados Esse 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 uma conta de dimensionamento automático do Azure Cosmos DB para a API do Cassandra Esse modelo cria uma conta do Azure Cosmos DB para a API do Cassandra em duas regiões com um keyspace e uma tabela com taxa de transferência de dimensionamento automático.
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core) Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2023-11-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 tipo para especificar o tipo de objeto.

Para contínua, use:

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

Para Periódica, use:

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

Valores de propriedade

AnalyticalStorageConfiguration

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

ApiProperties

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

BackupPolicy

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

BackupPolicyMigrationState

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

Capacidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto na conta. Um totalthroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para 2000. Um totalThroughputLimit de -1 não indica limites de provisionamento de taxa de transferência. int

Restrições:
Valor mínimo = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

ConsistencyPolicy

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

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para esse valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. int

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

ContinuousModeBackupPolicy

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

ContinuousModeProperties

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. corda
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. corda
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. corda
maxAgeInSeconds O tempo máximo de tempo que um navegador deve armazenar em cache a solicitação OPTIONS de pré-vôo. int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. analyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. backupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta de funcionalidade do []
capacidade O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. de capacidade do
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Padrão'
'Restaurar'
customerManagedKeyStatus Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. corda
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. corda
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 Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação. Bool
enableAnalyticalStorage Sinalizar para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. Bool
enableBurstCapacity Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta Bool
enableCassandraConnector Habilita o conector do Cassandra na conta do C* do Cosmos DB Bool
enableFreeTier Sinalizar para indicar se a Camada Livre está habilitada. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
enablePartitionMerge Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta Bool
ipRules Lista de IpRules. IpAddressOrRange []
isVirtualNetworkFilterEnabled Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. Bool
keyVaultKeyUri O URI do cofre de chaves corda
Locais Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB. Local[] (obrigatório)
minimalTlsVersion Indica a versão mínima de TLS permitida. 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 verificações de firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desabilitado'
'Habilitado'
'SecuredByPerimeter'
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

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

IpAddressOrRange

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

Localização

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

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Nome Descrição Valor
apiVersion A versão da API '2023-11-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. corda
nome O nome do recurso corda

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)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts'

PeriodicModeBackupPolicy

Nome 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

Nome 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 é mantido int

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

RestoreParameters

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

Tags

Nome Descrição Valor

VirtualNetworkRule

Nome Descrição Valor
id ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. corda
ignoreMissingVNetServiceEndpoint Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade de serviço da 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 do SQL da conta do Azure Cosmos DB com o repositório analítico

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

Implantar no Azure 		Esse 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 o Jenkins no AKS (Serviço de Contêiner do Azure)

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

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

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

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL), especificando apenas as propriedades mínimas de recurso necessárias.
criar uma conta do Azure Cosmos DB sem servidor para a API do SQL

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB sem servidor para a API Core (SQL).
Criar uma conta do Azure Cosmos com toque zero e um aplicativo Web do Azure

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos, injeta o ponto de extremidade e as chaves do Cosmos DB nas configurações do Aplicativo Web do Azure e implanta um aplicativo Web ASP MVC do GitHub.
Criar uma conta do Azure Cosmos para a API do MongoDB

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

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de dimensionamento automático compartilhada e dedicada.
criar uma conta do Azure Cosmos para a API de Tabela

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API de Tabela em duas regiões e uma única tabela com taxa de transferência provisionada.
Criar uma conta do Azure Cosmos para a API de Tabela com de dimensionamento automático

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

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

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

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

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

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para qualquer tipo de API de banco de dados com uma região primária e secundária com escolha de nível de consistência e tipo de failover.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner 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 		Esse modelo criará uma conta do Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta do Cosmos à rede virtual.
criar uma conta SQL do Azure Cosmos DB com o RBAC do plano de dados

Implantar no Azure 		Esse 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 uma conta de dimensionamento automático do Azure Cosmos DB para a API do Cassandra

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

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

Implantar no Azure 		O modelo cria um contêiner do Cosmos com uma API do SQL e permite adicionar contêineres mulitple.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner

Implantar no Azure 		Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner

Implantar no Azure 		Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

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

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

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

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

  • grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2023-11-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 tipo para especificar o tipo de objeto.

Para contínua, use:

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

Para Periódica, use:

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

Valores de propriedade

AnalyticalStorageConfiguration

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

ApiProperties

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

BackupPolicy

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

BackupPolicyMigrationState

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

Capacidade

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

Capacidade

Nome Descrição Valor
totalThroughputLimit O limite total de taxa de transferência imposto na conta. Um totalthroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para 2000. Um totalThroughputLimit de -1 não indica limites de provisionamento de taxa de transferência. int

Restrições:
Valor mínimo = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

ConsistencyPolicy

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

Restrições:
Valor mínimo = 5
Valor máximo = 86400
maxStalenessPrefix Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para esse valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy é definido como 'BoundedStaleness'. int

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

ContinuousModeBackupPolicy

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

ContinuousModeProperties

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

CorsPolicy

Nome Descrição Valor
allowedHeaders Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS. corda
allowedMethods Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS. corda
allowedOrigins Os domínios de origem que têm permissão para fazer uma solicitação no serviço por meio do CORS. cadeia de caracteres (obrigatório)
exposedHeaders Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação. corda
maxAgeInSeconds O tempo máximo de tempo que um navegador deve armazenar em cache a solicitação OPTIONS de pré-vôo. int

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nome Descrição Valor
analyticalStorageConfiguration Propriedades específicas do armazenamento analítico. analyticalStorageConfiguration
apiProperties Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB. ApiProperties
backupPolicy O objeto que representa a política para fazer backups em uma conta. backupPolicy
Capacidades Lista de recursos do Cosmos DB para a conta de funcionalidade do []
capacidade O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta. de capacidade do
connectorOffer O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB. 'Pequeno'
consistencyPolicy A política de consistência da conta do Cosmos DB. ConsistencyPolicy
cors A política CORS para a conta de banco de dados do Cosmos DB. CorsPolicy[]
createMode Enumerar para indicar o modo de criação da conta. 'Padrão'
'Restaurar'
customerManagedKeyStatus Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas. corda
databaseAccountOfferType O tipo de oferta para o banco de dados 'Standard' (obrigatório)
defaultIdentity A identidade padrão para acessar o cofre de chaves usado em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais. corda
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 Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação. Bool
enableAnalyticalStorage Sinalizar para indicar se a análise de armazenamento deve ser habilitada. Bool
enableAutomaticFailover Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. Bool
enableBurstCapacity Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta Bool
enableCassandraConnector Habilita o conector do Cassandra na conta do C* do Cosmos DB Bool
enableFreeTier Sinalizar para indicar se a Camada Livre está habilitada. Bool
enableMultipleWriteLocations Permite que a conta escreva em vários locais Bool
enablePartitionMerge Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta Bool
ipRules Lista de IpRules. IpAddressOrRange []
isVirtualNetworkFilterEnabled Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas. Bool
keyVaultKeyUri O URI do cofre de chaves corda
Locais Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB. Local[] (obrigatório)
minimalTlsVersion Indica a versão mínima de TLS permitida. 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 verificações de firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB. string[]
publicNetworkAccess Se as solicitações da Rede Pública são permitidas 'Desabilitado'
'Habilitado'
'SecuredByPerimeter'
restoreParameters Parâmetros para indicar as informações sobre a restauração. RestoreParameters
virtualNetworkRules Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

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

IpAddressOrRange

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

Localização

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

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.DocumentDB/databaseAccounts

Nome 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. corda
nome O nome do recurso corda

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)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts@2023-11-15"

PeriodicModeBackupPolicy

Nome 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

Nome 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 é mantido int

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

RestoreParameters

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

Tags

Nome Descrição Valor

VirtualNetworkRule

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