Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte Recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: databaseAccounts
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': 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.
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
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nome Descrição Valor
opções Um par chave-valor de opções a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de dimensionamento automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. Dimensionamento automáticoConfigurações
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

Dimensionamento automáticoConfigurações

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nome Descrição Valor
createMode Enumerar para indicar o modo de criação de recursos. 'Padrão'
'PointInTimeRestore'
'Restore'
id Nome do banco de dados SQL do Cosmos DB cadeia de caracteres (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

ResourceRestoreParameters

Nome Descrição Valor
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} string
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. bool

Modelos de início rápido

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

Modelo Descrição
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure
Este 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 compartilhada e contêiner.
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.
API do SQL da conta do Azure Cosmos DB com 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.
Criar uma API de SQL de conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure
Este modelo cria uma API de conta do Azure Cosmos para 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 procedimentos armazenados da API do SQL (Azure Cosmos DB Core)

Implantar no Azure
Este 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.
Implantar o Azure Data Explorer DB com a conexão do Cosmos DB

Implantar no Azure
Implante o Azure Data Explorer DB com a conexão do Cosmos DB.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'
apiVersion A versão da API de recursos '2024-02-15-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': 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á todas as identidades do serviço.
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nome Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nome Descrição Valor
createMode Enumeração para indicar o modo de criação de recursos. 'Padrão'
'PointInTimeRestore'
'Restore'
id Nome do banco de dados SQL do Cosmos DB cadeia de caracteres (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

ResourceRestoreParameters

Nome Descrição Valor
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} string
restoreTimestampInUtc Hora em que a conta precisa ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. bool

Modelos de início rápido

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

Modelo Descrição
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure
Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para a API do SQL com um banco de dados com taxa de transferência compartilhada e contêiner.
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.
API do SQL da conta do Azure Cosmos DB com 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.
Criar uma API de SQL da conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure
Esse modelo cria uma conta do Azure Cosmos para a API 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 procedimentos armazenados da API do Azure Cosmos DB Core (SQL)

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, um gatilho e uma função definida pelo usuário.
Implantar o Azure Data Explorer DB com a conexão do Cosmos DB

Implantar no Azure
Implante o Azure Data Explorer DB com a conexão do Cosmos DB.

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

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

  • Grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

Valores de propriedade

databaseAccounts/sqlDatabases

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview"
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: databaseAccounts
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório)

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nome Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nome Descrição Valor
createMode Enumeração para indicar o modo de criação de recursos. "Padrão"
"PointInTimeRestore"
"Restaurar"
id Nome do banco de dados SQL do Cosmos DB cadeia de caracteres (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

ResourceRestoreParameters

Nome Descrição Valor
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} string
restoreTimestampInUtc Hora em que a conta precisa ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. bool