Banco de dados Microsoft.DocumentDBAccounts 2023-03-01-preview

Definição de recurso do Bicep

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

• Grupos de recursos - Consulte comandos de implantação do grupo 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 Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-03-01-preview' = {
  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'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: 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'
      sourceBackupLocation: '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

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tags

VirtualNetworkRule

Exemplos de início rápido

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

Definição de recurso de modelo do ARM

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

• Grupos de recursos - Consulte comandos de implantação do grupo 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 JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2023-03-01-preview",
  "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",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "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",
      "sourceBackupLocation": "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

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tags

VirtualNetworkRule

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	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.
CI/CD usando o Jenkins no AKS (Serviço de Contêiner do 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	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.
criar o Azure Cosmos com a API do SQL e vários contêineres	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	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.
Aplicativo Web com um Banco de Dados SQL, Azure Cosmos DB, Azure Search	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-03-01-preview"
  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"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = 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"
        sourceBackupLocation = "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

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacidade

Capacidade

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Localização

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tags

VirtualNetworkRule