Partilhar via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2024-08-15

  • Artigo

Definição de recursos do bíceps

O tipo de recurso databaseAccounts/gremlinDatabases 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 do recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-08-15' = {
  parent: resourceSymbolicName
  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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obrigatório)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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 Cosmos DB Gremlin string (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Designação Descrição Valor
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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (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

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
Criar uma conta do Azure Cosmos DB para a API Gremlin Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o de dimensionamento automático da API Gremlin Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts/gremlinDatabases 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 do recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2024-08-15",
  "name": "string",
  "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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obrigatório)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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 Cosmos DB Gremlin string (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Designação Descrição Valor
apiVersion A versão api '2024-08-15'
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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (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/gremlinDatabases'

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

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
Criar uma conta do Azure Cosmos DB para a API Gremlin

Implantar no Azure 		Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o de dimensionamento automático da API Gremlin

Implantar no Azure 		Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.

Definição de recursos 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 do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-08-15"
  name = "string"
  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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso O formato JSON padrão de um banco de dados Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obrigatório)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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 Cosmos DB Gremlin string (obrigatório)
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Designação Descrição Valor
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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-08-15"

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

Etiquetas

Designação Descrição Valor