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

Definição de recursos do bíceps

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

Grupos de recursos - Consulte comandos de implantação de grupo 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/sqlDatabases, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-09-01-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

Designação	Descrição	Valor
maxTaxa de transferência	Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação	Descrição	Valor

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Designação	Descrição	Valor
autoscaleConfigurações	Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas.	AutoscaleSettings
taxa de transferência	Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.	Int

ManagedServiceIdentity

Designação	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 'Nenhum' removerá todas as identidades do serviço.	'Nenhuma' '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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação	Descrição	Valor

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

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

ResourceRestoreParameters

Designação	Descrição	Valor
restaurarFonte	A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601).	string
restoreWithTtlDisabled	Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Designação	Descrição	Valor
Opções	Um par de opções chave-valor 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	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Designação	Descrição	Valor
createMode	Enum para indicar o modo de criação de recursos.	'Inadimplência' 'Restaurar'
ID	Nome do banco de dados SQL do Cosmos DB	string (obrigatório)
restoreParameters	Parâmetros para indicar as informações sobre a restauração	ResourceRestoreParameters

Etiquetas

Designação	Descrição	Valor

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 SQL da conta do Azure Cosmos DB com de armazenamento analítico	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico.
Criar uma conta gratuita do Azure Cosmos DB	Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API 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 Core (SQL)	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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)	Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB	Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.

Definição de recurso de modelo ARM

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

Grupos de recursos - Consulte comandos de implantação de grupo 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/sqlDatabases, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-09-01-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

Designação	Descrição	Valor
maxTaxa de transferência	Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação	Descrição	Valor

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Designação	Descrição	Valor
autoscaleConfigurações	Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas.	AutoscaleSettings
taxa de transferência	Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.	Int

ManagedServiceIdentity

Designação	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 'Nenhum' removerá todas as identidades do serviço.	'Nenhuma' '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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação	Descrição	Valor

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Designação	Descrição	Valor
apiVersion	A versão api	'2024-09-01-pré-visualização'
identidade	Identidade do recurso.	ManagedServiceIdentity
Localização	O local do grupo de recursos ao qual o recurso pertence.	string
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório)
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'

ResourceRestoreParameters

Designação	Descrição	Valor
restaurarFonte	A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601).	string
restoreWithTtlDisabled	Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Designação	Descrição	Valor
Opções	Um par de opções chave-valor 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	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Designação	Descrição	Valor
createMode	Enum para indicar o modo de criação de recursos.	'Inadimplência' 'Restaurar'
ID	Nome do banco de dados SQL do Cosmos DB	string (obrigatório)
restoreParameters	Parâmetros para indicar as informações sobre a restauração	ResourceRestoreParameters

Etiquetas

Designação	Descrição	Valor

Modelos de início rápido

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

Modelo	Descrição
API SQL da conta do Azure Cosmos DB com de armazenamento analítico	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico.
Criar uma conta gratuita do Azure Cosmos DB	Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API 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 Core (SQL)	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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	Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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)	Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB	Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.

Definição de recursos Terraform (provedor 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 log de alterações.

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-09-01-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

Designação	Descrição	Valor
maxTaxa de transferência	Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação	Descrição	Valor

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Designação	Descrição	Valor
autoscaleConfigurações	Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas.	AutoscaleSettings
taxa de transferência	Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.	Int

ManagedServiceIdentity

Designação	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 'Nenhum' removerá todas as identidades do serviço.	'Nenhuma' '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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação	Descrição	Valor

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Designação	Descrição	Valor
identidade	Identidade do recurso.	ManagedServiceIdentity
Localização	O local do grupo de recursos ao qual o recurso pertence.	string
Designação	O nome do recurso	string (obrigatório)
parent_id	A ID do recurso que é o pai para este recurso.	ID para recurso do tipo: databaseAccounts
propriedades	Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório)
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-09-01-preview"

ResourceRestoreParameters

Designação	Descrição	Valor
restaurarFonte	A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601).	string
restoreWithTtlDisabled	Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Designação	Descrição	Valor
Opções	Um par de opções chave-valor 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	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Designação	Descrição	Valor
createMode	Enum para indicar o modo de criação de recursos.	'Inadimplência' 'Restaurar'
ID	Nome do banco de dados SQL do Cosmos DB	string (obrigatório)
restoreParameters	Parâmetros para indicar as informações sobre a restauração	ResourceRestoreParameters

Etiquetas

Designação	Descrição	Valor

Partilhar via

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2024-09-01-preview

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Etiquetas

Exemplos de início rápido

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Etiquetas

Modelos de início rápido

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

AutoscaleSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Etiquetas

Comentários

Recursos adicionais