Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/gremlinDatabases 2023-11-15-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/gremlinDatabases se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Valor

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o autoscaleSettings, pero no ambos. AutoscaleSettings
Rendimiento Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nombre Descripción Valor
Opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso El formato JSON estándar de una base de datos de Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatorio)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. 'Valor predeterminado'
'PointInTimeRestore'
'Restaurar'
identificación Nombre de la base de datos de Gremlin de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración resourceRestoreParameters

ManagedServiceIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. managedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nombre Descripción Valor
identidad Identidad del recurso. managedServiceIdentity
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: databaseAccounts
Propiedades Propiedades para crear y actualizar la base de datos de Gremlin de Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cuerda
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda

Etiquetas

Nombre Descripción Valor

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep Descripción
Creación de una cuenta de Azure Cosmos DB para gremlin API Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado.
Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalabilidad automática.

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/gremlinDatabases se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2023-11-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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Valor

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o autoscaleSettings, pero no ambos. AutoscaleSettings
Rendimiento Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nombre Descripción Valor
Opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso El formato JSON estándar de una base de datos de Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatorio)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. 'Valor predeterminado'
'PointInTimeRestore'
'Restaurar'
identificación Nombre de la base de datos de Gremlin de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración resourceRestoreParameters

ManagedServiceIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. managedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nombre Descripción Valor
apiVersion La versión de api "2023-11-15-preview"
identidad Identidad del recurso. managedServiceIdentity
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades para crear y actualizar la base de datos de Gremlin de Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cuerda
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda

Etiquetas

Nombre Descripción Valor

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta de Azure Cosmos DB para gremlin API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado.
Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalabilidad automática.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/gremlinDatabases se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-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"
        }
      }
    }
  })
}

Valores de propiedad

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Valor

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o autoscaleSettings, pero no ambos. AutoscaleSettings
Rendimiento Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nombre Descripción Valor
Opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
recurso El formato JSON estándar de una base de datos de Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatorio)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. 'Valor predeterminado'
'PointInTimeRestore'
'Restaurar'
identificación Nombre de la base de datos de Gremlin de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración resourceRestoreParameters

ManagedServiceIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. managedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nombre Descripción Valor
identidad Identidad del recurso. managedServiceIdentity
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: databaseAccounts
Propiedades Propiedades para crear y actualizar la base de datos de Gremlin de Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-15-preview"

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cuerda
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda

Etiquetas

Nombre Descripción Valor