Banco de dados Microsoft.DocumentDBContas 2021-03-01-preview

Definição de recursos do bíceps

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

• Resource groups - Ver comandos de implementação resource groups

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

Formato do recurso

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

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

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Defina a propriedade createMode para especificar o tipo de objeto.

Para padrão , use:

{
  createMode: 'Default'
}

Para Restaurar, use:

{
  createMode: 'Restore'
  restoreParameters: {
    databasesToRestore: [
      {
        collectionNames: [
          'string'
        ]
        databaseName: 'string'
      }
    ]
    restoreMode: 'string'
    restoreSource: 'string'
    restoreTimestampInUtc: 'string'
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  type: 'Continuous'
}

Para Periódica , utilize:

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

Exemplos de uso

Amostras de bíceps

Um exemplo básico de implantação da Conta do CosmosDB (formalmente Banco de Dados de Documentos).

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'BoundedStaleness'
      maxIntervalInSeconds: 10
      maxStalenessPrefix: 200
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

Módulos verificados do Azure

Os seguintes Azure Módulos Verificados podem ser usados para implementar este tipo de recurso.

Exemplos de início rápido do Azure

Os seguintes modelos Azure Quickstart contêm amostras de Bicep para a implementação deste tipo de recurso.

Definição de recurso de modelo ARM

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

• Resource groups - Ver comandos de implementação resource groups

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

Formato do recurso

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

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

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Defina a propriedade createMode para especificar o tipo de objeto.

Para padrão , use:

{
  "createMode": "Default"
}

Para Restaurar, use:

{
  "createMode": "Restore",
  "restoreParameters": {
    "databasesToRestore": [
      {
        "collectionNames": [ "string" ],
        "databaseName": "string"
      }
    ],
    "restoreMode": "string",
    "restoreSource": "string",
    "restoreTimestampInUtc": "string"
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  "type": "Continuous"
}

Para Periódica , utilize:

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

Exemplos de uso

Modelos de Início Rápido do Azure

Os seguintes modelos Azure Quickstart implementam este tipo de recurso.

Template	Description
Azure API SQL da conta Cosmos DB com armazenamento analítico	Este modelo cria uma conta Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor configurados com armazenamento analítico.
Azure Conta Cosmos DB com Web App	Este modelo implementa uma conta Azure Cosmos DB, um App Service Plan e cria uma Web App no App Service Plan. Também adiciona duas definições de aplicação à Web App que fazem referência ao endpoint da conta do Azure Cosmos DB. Desta forma, as soluções implementadas na Web App podem ligar-se ao endpoint da conta do Azure Cosmos DB usando essas definições.
CI/CD usando Jenkins no Azure Container Service (AKS)	Os contêineres facilitam muito a criação e a implantação contínuas de seus aplicativos. Ao orquestrar a implementação desses contentores usando o Kubernetes no Azure Container Service, pode obter clusters de containers replicáveis e gerí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.
Crie uma conta de base de dados Cosmos com o Microsoft Defender ativado	Usando este modelo ARM, pode implementar uma conta Azure Cosmos DB com o Microsoft Defender for Azure Cosmos DB ativado. Microsoft Defender for Azure Cosmos DB é uma camada de segurança nativa do Azure que deteta tentativas de explorar bases de dados nas suas contas Azure Cosmos DB. O Microsoft Defender for Azure Cosmos DB deteta potenciais injeções SQL, agentes maliciosos conhecidos com base no Microsoft Threat Intelligence, padrões de acesso suspeitos e potenciais explorações da sua base de dados através de identidades comprometidas ou insiders maliciosos.
Crie uma conta gratuita Azure Cosmos DB	Este modelo cria uma conta Azure Cosmos DB de nível gratuito para API SQL com uma base de dados com débito e contentor partilhados.
Crie uma conta mínima Azure Cosmos DB para a API Core (SQL)	Este modelo cria uma conta Azure Cosmos DB para a API Core (SQL), especificando apenas as propriedades mínimas de recursos necessárias.
Crie uma conta serverless Azure Cosmos DB para API SQL	Este modelo cria uma conta serverless no Azure Cosmos DB para a API Core (SQL).
Criar uma conta zero touch Azure Cosmos e Azure Web App	Este modelo cria uma conta Azure Cosmos, injeta o endpoint do Cosmos DB e faz a chave nas definições do Azure Web App, depois implementa uma aplicação web ASP MVC a partir do GitHub.
Criar uma conta Azure Cosmos para a API MongoDB	Este modelo cria uma conta Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões, usando um throughput partilhado e dedicado com duas coleções.
Crie uma conta Azure Cosmos para a API MongoDB autoscale	Este modelo cria uma conta Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões, utilizando throughput autoscale partilhado e dedicado.
Criar uma conta Azure Cosmos para a API de Tabelas	Este modelo cria uma conta Azure Cosmos DB para a API Table em duas regiões e uma única tabela com débito provisionado.
Crie uma conta Azure Cosmos para a API Table com autoscale	Este modelo cria uma conta Azure Cosmos DB para a API de Tabelas em duas regiões e uma única tabela com débito de escalabilidade automática.
Crie uma conta Azure Cosmos DB para a API Cassandra	Este modelo cria uma conta Azure Cosmos DB para a API Cassandra em duas regiões com um espaço de chaves e uma tabela com débito dedicado.
Crie uma conta Azure Cosmos DB para a API Core (SQL)	Este modelo cria uma conta Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com throughput e múltiplas outras opções.
Crie uma conta Azure Cosmos DB para a API Gremlin	Este modelo cria uma conta Azure Cosmos DB para a API Gremlin em duas regiões, com uma base de dados e um grafo usando throughput dedicado.
Crie uma conta de base de dados Azure Cosmos para autoscale	Este modelo cria uma conta Azure Cosmos DB para a API Gremlin em duas regiões, com uma base de dados e um grafo, usando autoscale throughput.
Crie uma conta Azure Cosmos DB em várias regiões	Este modelo cria uma conta Azure Cosmos DB para qualquer tipo de API de base de dados com uma região primária e secundária, com escolha de nível de consistência e tipo de failover.
Crie uma API SQL de Azure conta Cosmos DB com autoscale	Este modelo cria uma conta Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito autoescalável e múltiplas outras opções.
Crie uma conta de base de dados Azure Cosmos com um endpoint privado	Este modelo criará uma conta Cosmos, uma virtual network e um endpoint privado que expõe a conta Cosmos à virtual network.
Crie uma Conta SQL Azure Cosmos DB com 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.
Crie uma Conta Azure CosmosDB	Este modelo ARM tem a intenção de criar uma conta do CosmosDB rapidamente com os valores mínimos necessários
Create autoscale Azure conta Cosmos DB para Cassandra API	Este modelo cria uma conta de base de dados Azure Cosmos para a API Cassandra em duas regiões, com um espaço de chaves e uma tabela com débito autoescalável.
Create Azure procedimentos armazenados da API Cosmos DB Core (SQL)	Este modelo cria uma conta Azure Cosmos DB para a API Core (SQL) e um contentor com procedimento armazenado, trigger e função definida pelo utilizador.
Create Azure Cosmos com API SQL e múltiplos contentores	O modelo cria um contêiner Cosmos com uma API SQL e permite adicionar vários contêineres.
Cria uma aplicação de microserviços Dapr usando Aplicações Container	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria uma aplicação de Servicebus pub-sub Dapr usando Aplicações Container	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implementar Azure Data Explorer base de dados com ligação ao Cosmos DB	Deploy Azure Data Explorer DB com conexão Cosmos DB.
Aplicação Web com base de dados SQL, Azure Cosmos DB, Azure Search	Este modelo prevê uma Web App, uma Base de Dados SQL, Azure Cosmos DB, Azure Search e Application Insights.

Definição de recursos Terraform (provedor AzAPI)

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

• Grupos de recursos

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

Formato do recurso

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

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

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Defina a propriedade createMode para especificar o tipo de objeto.

Para padrão , use:

{
  createMode = "Default"
}

Para Restaurar, use:

{
  createMode = "Restore"
  restoreParameters = {
    databasesToRestore = [
      {
        collectionNames = [
          "string"
        ]
        databaseName = "string"
      }
    ]
    restoreMode = "string"
    restoreSource = "string"
    restoreTimestampInUtc = "string"
  }
}

Objetos BackupPolicy

Defina a propriedade type para especificar o tipo de objeto.

Para contínuo, utilize:

{
  type = "Continuous"
}

Para Periódica , utilize:

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação da Conta do CosmosDB (formalmente Banco de Dados de Documentos).

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}