Base de dados Microsoft.DocumentDBAccounts/sqlDatabases
- Mais recente
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 01-2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 01-2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 06-2020-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definição de recurso do Bicep
O tipo de recurso databaseAccounts/sqlDatabases pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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 subordinados no Bicep. |
cadeia (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| principal | No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal. |
Nome simbólico para recurso do tipo: databaseAccounts |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar a base de dados SQL do Azure Cosmos DB. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "Nenhum" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso | O formato JSON padrão de uma base de dados SQL | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome | Descrição | Valor |
|---|---|---|
| autoscaleSettings | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambos. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Nome | Descrição | Valor |
|---|---|---|
| createMode | Enumerar para indicar o modo de criação de recursos. | 'Predefinição' "PointInTimeRestore" "Restaurar" |
| ID | Nome da base de dados SQL do Cosmos DB | cadeia (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados restabelecida a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar uma conta do Azure Cosmos DB de escalão gratuito |
Este modelo cria uma conta do Azure Cosmos DB de escalão gratuito para a API SQL com uma base de dados com débito e contentor partilhados. |
| Criar uma conta do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito com várias outras opções. |
| API SQL da conta do Azure Cosmos DB com arquivo analítico |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico. |
| Criar uma API SQL de conta do Azure Cosmos DB com o dimensionamento automático |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito 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 contentor com um procedimento armazenado, um acionador e uma função definida pelo utilizador. |
| Implementar o Azure Data Explorer DB com a ligação do Cosmos DB |
Implementar o Azure Data Explorer DB com a ligação do Cosmos DB. |
Definição de recurso do modelo arm
O tipo de recurso databaseAccounts/sqlDatabases pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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 subordinados em modelos do ARM JSON. |
cadeia (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar a base de dados SQL do Azure Cosmos DB. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "Nenhum" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso | O formato JSON padrão de uma base de dados SQL | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome | Descrição | Valor |
|---|---|---|
| dimensionamento automáticoDefinições | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambas. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Nome | Descrição | Valor |
|---|---|---|
| createMode | Enum para indicar o modo de criação de recursos. | 'Predefinição' 'PointInTimeRestore' "Restaurar" |
| ID | Nome da base de dados SQL do Cosmos DB | cadeia (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar uma conta do Azure Cosmos DB de escalão gratuito |
Este modelo cria uma conta do Azure Cosmos DB de escalão gratuito para a API SQL com uma base de dados com débito e contentor partilhados. |
| Criar uma conta do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito com várias outras opções. |
| API SQL da conta do Azure Cosmos DB com arquivo analítico |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico. |
| Criar uma API SQL de conta do Azure Cosmos DB com o dimensionamento automático |
Este modelo cria uma conta do Azure Cosmos para a API Core (SQL) com uma base de dados e um contentor com débito 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 contentor com um procedimento armazenado, um acionador e uma função definida pelo utilizador. |
| Implementar o Azure Data Explorer DB com a ligação do Cosmos DB |
Implementar o Azure Data Explorer DB com a ligação do Cosmos DB. |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso databaseAccounts/sqlDatabases pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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 (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| parent_id | O ID do recurso que é o principal para este recurso. | ID do recurso do tipo: databaseAccounts |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar a base de dados SQL do Azure Cosmos DB. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| identity_ids | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Matriz de IDs de identidade do utilizador. |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso | O formato JSON padrão de uma base de dados SQL | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obrigatório) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome | Descrição | Valor |
|---|---|---|
| dimensionamento automáticoDefinições | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambas. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Nome | Descrição | Valor |
|---|---|---|
| createMode | Enum para indicar o modo de criação de recursos. | "Predefinição" "PointInTimeRestore" "Restaurar" |
| ID | Nome da base de dados SQL do Cosmos DB | cadeia (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários