Compartir a través de

DatabaseAccounts/gremlinDatabases/graphs 2021-10-15

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/gremlinDatabases/graphs 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/graphs, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              '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

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación para rutas de acceso compuestas. 'ascendente'
'descendente'
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. cuerda
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. cuerda
modo Indica el modo de resolución de conflictos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nombre Descripción Valor
amable Indica el tipo de algoritmo usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores. 'Hash'
"MultiHash"
'Range'
Caminos Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor string[]
Versión Indica la versión de la definición de clave de partición. Int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

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

ExcludedPath

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

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. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso El formato JSON estándar de un grafo de Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatorio)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nombre Descripción Valor
conflictResolutionPolicy Directiva de resolución de conflictos para el gráfico. ConflictResolutionPolicy
defaultTtl Período de vida predeterminado Int
identificación Nombre del grafo gremlin de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del grafo. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKeyPolicy

IncludedPath

Nombre Descripción Valor
Índices Lista de índices para esta ruta de acceso índices de []
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

Índices

Nombre Descripción Valor
Datatype Tipo de datos al que se aplica el comportamiento de indexación. 'LineString'
"MultiPolygon"
'Número'
'Point'
'Polygon'
'String'
amable Indica el tipo de índice. 'Hash'
'Range'
"Espacial"
precisión Precisión del índice. -1 es la precisión máxima. Int

IndexingPolicy

Nombre Descripción Valor
Automático Indica si la directiva de indexación es automática. Bool
compositeIndexes Lista de la lista de rutas de acceso compuestas CompositePath[][]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. 'coherente'
'diferido'
'none'
spatialIndexes Lista de detalles espaciales spatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nombre Descripción Valor
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/gremlinDatabases
Propiedades Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

SpatialSpec

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda
Tipos Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
'LineString'
"MultiPolygon"
'Point'
'Polygon'

Etiquetas

Nombre Descripción Valor

UniqueKey

Nombre Descripción Valor
Caminos La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en que exige la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKey[]

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/graphs 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/graphs, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2021-10-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "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

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación para rutas de acceso compuestas. 'ascendente'
'descendente'
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. cuerda
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. cuerda
modo Indica el modo de resolución de conflictos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nombre Descripción Valor
amable Indica el tipo de algoritmo usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores. 'Hash'
"MultiHash"
'Range'
Caminos Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor string[]
Versión Indica la versión de la definición de clave de partición. Int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

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

ExcludedPath

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

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. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso El formato JSON estándar de un grafo de Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatorio)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nombre Descripción Valor
conflictResolutionPolicy Directiva de resolución de conflictos para el gráfico. ConflictResolutionPolicy
defaultTtl Período de vida predeterminado Int
identificación Nombre del grafo gremlin de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del grafo. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKeyPolicy

IncludedPath

Nombre Descripción Valor
Índices Lista de índices para esta ruta de acceso índices de []
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

Índices

Nombre Descripción Valor
Datatype Tipo de datos al que se aplica el comportamiento de indexación. 'LineString'
"MultiPolygon"
'Número'
'Point'
'Polygon'
'String'
amable Indica el tipo de índice. 'Hash'
'Range'
"Espacial"
precisión Precisión del índice. -1 es la precisión máxima. Int

IndexingPolicy

Nombre Descripción Valor
Automático Indica si la directiva de indexación es automática. Bool
compositeIndexes Lista de la lista de rutas de acceso compuestas CompositePath[][]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. 'coherente'
'diferido'
'none'
spatialIndexes Lista de detalles espaciales spatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nombre Descripción Valor
apiVersion La versión de api '2021-10-15'
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 el grafo de Gremlin de Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (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/graphs'

SpatialSpec

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda
Tipos Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
'LineString'
"MultiPolygon"
'Point'
'Polygon'

Etiquetas

Nombre Descripción Valor

UniqueKey

Nombre Descripción Valor
Caminos La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en que exige la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKey[]

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/graphs 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/graphs, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propiedad

AutoscaleSettings

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

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación para rutas de acceso compuestas. 'ascendente'
'descendente'
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. cuerda
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. cuerda
modo Indica el modo de resolución de conflictos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nombre Descripción Valor
amable Indica el tipo de algoritmo usado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres como máximo) para la creación de contenedores. 'Hash'
"MultiHash"
'Range'
Caminos Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor string[]
Versión Indica la versión de la definición de clave de partición. Int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

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

ExcludedPath

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

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. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso El formato JSON estándar de un grafo de Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatorio)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nombre Descripción Valor
conflictResolutionPolicy Directiva de resolución de conflictos para el gráfico. ConflictResolutionPolicy
defaultTtl Período de vida predeterminado Int
identificación Nombre del grafo gremlin de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del grafo. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKeyPolicy

IncludedPath

Nombre Descripción Valor
Índices Lista de índices para esta ruta de acceso índices de []
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda

Índices

Nombre Descripción Valor
Datatype Tipo de datos al que se aplica el comportamiento de indexación. 'LineString'
"MultiPolygon"
'Número'
'Point'
'Polygon'
'String'
amable Indica el tipo de índice. 'Hash'
'Range'
"Espacial"
precisión Precisión del índice. -1 es la precisión máxima. Int

IndexingPolicy

Nombre Descripción Valor
Automático Indica si la directiva de indexación es automática. Bool
compositeIndexes Lista de la lista de rutas de acceso compuestas CompositePath[][]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. 'coherente'
'diferido'
'none'
spatialIndexes Lista de detalles espaciales spatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nombre Descripción Valor
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/gremlinDatabases
Propiedades Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15"

SpatialSpec

Nombre Descripción Valor
camino Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con la raíz y terminan con comodín (/path/*) cuerda
Tipos Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
'LineString'
"MultiPolygon"
'Point'
'Polygon'

Etiquetas

Nombre Descripción Valor

UniqueKey

Nombre Descripción Valor
Caminos La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en que exige la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. uniqueKey[]