Banco de dados Microsoft.DocumentDBAccounts/gremlinDatabases 2024-02-15-preview
- Mais recente
- 2024-05-15
- 2024-05-15-preview
- 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
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15-01-2021
- 2020-09-01
- Versão prévia-01-06-2020
- 01-04-2020
- 2020-03-01
- 2019-12-12
- 01-08-2019
Definição de recurso do Bicep
O tipo de recurso databaseAccounts/gremlinDatabases pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo 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/gremlinDatabases, adicione o seguinte Bicep ao modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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/gremlinDatabases
| Name | 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). 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 |
| 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 Gremlin do Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obrigatório) |
ManagedServiceIdentity
| Name | 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á todas 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 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
| Name | 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.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Name | 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. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| recurso | O formato JSON padrão de um banco de dados Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obrigatório) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Name | 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
| Name | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Name | 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 Gremlin do Cosmos DB | cadeia de caracteres (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre a restauração | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | 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 do Azure Cosmos DB para a API do Gremlin |
Este 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 dedicada. |
| Criar uma conta do Azure Cosmos DB para 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. |
Definição de recurso de modelo do ARM
O tipo de recurso databaseAccounts/gremlinDatabases pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo 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/gremlinDatabases, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"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/gremlinDatabases
| Name | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases' |
| apiVersion | A versão da API do recurso | '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. Consulte Marcas em modelos |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| properties | Propriedades para criar e atualizar o banco de dados Gremlin do Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obrigatório) |
ManagedServiceIdentity
| Name | 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
| Name | 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.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Name | 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. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| recurso | O formato JSON padrão de um banco de dados Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obrigatório) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Name | 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
| Name | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Name | Descrição | Valor |
|---|---|---|
| createMode | Enumerar para indicar o modo de criação de recursos. | 'Padrão' 'PointInTimeRestore' 'Restore' |
| id | Nome do banco de dados Gremlin do Cosmos DB | cadeia de caracteres (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre a restauração | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | 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 do Azure Cosmos DB para a API do Gremlin |
Este 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 dimensionamento automático da API do Gremlin |
Este 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. |
Definição de recurso do Terraform (provedor AzAPI)
O tipo de recurso databaseAccounts/gremlinDatabases 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 de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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/gremlinDatabases
| Name | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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). 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. |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| properties | Propriedades para criar e atualizar o banco de dados Gremlin do Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obrigatório) |
ManagedServiceIdentity
| Name | 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. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | 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}'. | Matriz de IDs de identidade do usuário. |
ManagedServiceIdentityUserAssignedIdentities
| Name | 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.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Name | 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. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| recurso | O formato JSON padrão de um banco de dados Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obrigatório) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Name | 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
| Name | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Name | Descrição | Valor |
|---|---|---|
| createMode | Enumerar para indicar o modo de criação de recursos. | "Padrão" "PointInTimeRestore" "Restaurar" |
| id | Nome do banco de dados Gremlin do Cosmos DB | cadeia de caracteres (obrigatório) |
| restoreParameters | Parâmetros para indicar as informações sobre a restauração | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | 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 |