Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/gremlinDatabases 2024-02-15-preview

  • Artigo

Definição de recurso do Bicep

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 de log de alterações.

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-02-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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nome 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

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

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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (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

Tags

Nome 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 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 taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o 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:

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

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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nome 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

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

Nome Descrição Valor
apiVersion A versão da API '2024-02-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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (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/gremlinDatabases'

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

Tags

Nome 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 do Gremlin

Implantar no Azure 		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 taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin

Implantar no Azure 		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 do Terraform (provedor de 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 de log de alterações.

Formato de recurso

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

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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nome 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

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

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 Gremlin do Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-02-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

Tags

Nome Descrição Valor