Microsoft.DocumentDB/databaseAccounts/sqlDatabases 2024-05-15-preview - Bicep, ARM template & Terraform AzAPI reference

Definição de recurso do Bicep

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

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/sqlDatabases, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome	Descrição	Valor

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.	autoscaleSettings
throughput	Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000.	int

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/sqlDatabases

Nome	Descrição	Valor
identidade	Identidade do recurso.	ManagedServiceIdentity
localização	O local do grupo de recursos ao qual o recurso pertence.	corda
nome	O nome do recurso	cadeia de caracteres (obrigatório)
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 do recurso do tipo: databaseAccounts
Propriedades	Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

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}	corda
restoreTimestampInUtc	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).	corda
restoreWithTtlDisabled	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome	Descrição	Valor
Opções	Um par de opções chave-valor a ser aplicado à 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	sqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome	Descrição	Valor
createMode	Enumerar para indicar o modo de criação de recursos.	'Padrão' '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

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.
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 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 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 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/sqlDatabases pode ser implantado com operações direcionadas:

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/sqlDatabases, adicione o JSON a seguir ao modelo.

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

Valores de propriedade

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome	Descrição	Valor

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.	autoscaleSettings
throughput	Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000.	int

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/sqlDatabases

Nome	Descrição	Valor
apiVersion	A versão da API	'2024-05-15-preview'
identidade	Identidade do recurso.	ManagedServiceIdentity
localização	O local do grupo de recursos ao qual o recurso pertence.	corda
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (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/sqlDatabases'

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}	corda
restoreTimestampInUtc	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).	corda
restoreWithTtlDisabled	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome	Descrição	Valor
Opções	Um par de opções chave-valor a ser aplicado à 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	sqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome	Descrição	Valor
createMode	Enumerar para indicar o modo de criação de recursos.	'Padrão' '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

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.
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 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 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 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 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 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/sqlDatabases, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

Valores de propriedade

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome	Descrição	Valor

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.	autoscaleSettings
throughput	Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000.	int

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/sqlDatabases

Nome	Descrição	Valor
identidade	Identidade do recurso.	ManagedServiceIdentity
localização	O local do grupo de recursos ao qual o recurso pertence.	corda
nome	O nome do recurso	cadeia de caracteres (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: databaseAccounts
Propriedades	Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15-preview"

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}	corda
restoreTimestampInUtc	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).	corda
restoreWithTtlDisabled	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome	Descrição	Valor
Opções	Um par de opções chave-valor a ser aplicado à 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	sqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome	Descrição	Valor
createMode	Enumerar para indicar o modo de criação de recursos.	'Padrão' '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

Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases 2024-05-15-preview

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Exemplos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Comentários

Recursos adicionais