Partager via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2022-11-15

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/gremlinDatabases/graphs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      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'
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CompositePath

Nom Description Valeur
commande Ordre de tri pour les chemins composites. 'croissant'
'décroissant'
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur 'Hash'
'MultiHash'
'Range'
Chemins Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés string[]
Version Indique la version de la définition de clé de partition Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

ExcludedPath

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
ressource Format JSON standard d’un graphe Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatoire)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
conflictResolutionPolicy Stratégie de résolution des conflits pour le graphique. ConflictResolutionPolicy
defaultTtl Durée de vie par défaut Int
id Nom du graphe Gremlin Cosmos DB chaîne (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins d’accès au document dans le graphique IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Nom Description Valeur
Index Liste des index pour ce chemin d’accès Index[]
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

Index

Nom Description Valeur
Datatype Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Polygon'
'String'
gentil Indique le type d’index. 'Hash'
'Range'
'Spatial'
précision Précision de l’index. -1 est une précision maximale. Int

IndexingPolicy

Nom Description Valeur
Automatique Indique si la stratégie d’indexation est automatique Bool
compositeIndexes Liste des chemins composites CompositePath[][]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. 'cohérent'
'paresseux'
'none'
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts/gremlinDatabases
Propriétés Propriétés permettant de créer et de mettre à jour un graphe Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
Types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
'LineString'
'MultiPolygon'
'Point'
'Polygon'

Étiquettes

Nom Description Valeur

UniqueKey

Nom Description Valeur
Chemins La liste des chemins d’accès doit être unique pour chaque document du service Azure Cosmos DB string[]

UniqueKeyPolicy

Nom Description Valeur
uniquesKeys Liste des clés uniques sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
créer un compte Azure Cosmos DB pour l' de l’API Gremlin Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant un débit dédié.
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide du débit de mise à l’échelle automatique.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/gremlinDatabases/graphs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2022-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "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"
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CompositePath

Nom Description Valeur
commande Ordre de tri pour les chemins composites. 'croissant'
'décroissant'
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur 'Hash'
'MultiHash'
'Range'
Chemins Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés string[]
Version Indique la version de la définition de clé de partition Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

ExcludedPath

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
ressource Format JSON standard d’un graphe Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatoire)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
conflictResolutionPolicy Stratégie de résolution des conflits pour le graphique. ConflictResolutionPolicy
defaultTtl Durée de vie par défaut Int
id Nom du graphe Gremlin Cosmos DB chaîne (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins d’accès au document dans le graphique IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Nom Description Valeur
Index Liste des index pour ce chemin d’accès Index[]
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

Index

Nom Description Valeur
Datatype Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Polygon'
'String'
gentil Indique le type d’index. 'Hash'
'Range'
'Spatial'
précision Précision de l’index. -1 est une précision maximale. Int

IndexingPolicy

Nom Description Valeur
Automatique Indique si la stratégie d’indexation est automatique Bool
compositeIndexes Liste des chemins composites CompositePath[][]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. 'cohérent'
'paresseux'
'none'
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
apiVersion Version de l’API '2022-11-15'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour un graphe Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
Types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
'LineString'
'MultiPolygon'
'Point'
'Polygon'

Étiquettes

Nom Description Valeur

UniqueKey

Nom Description Valeur
Chemins La liste des chemins d’accès doit être unique pour chaque document du service Azure Cosmos DB string[]

UniqueKeyPolicy

Nom Description Valeur
uniquesKeys Liste des clés uniques sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
créer un compte Azure Cosmos DB pour l' de l’API Gremlin

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant un débit dédié.
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide du débit de mise à l’échelle automatique.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/gremlinDatabases/graphs peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        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"
              ]
            }
          ]
        }
      }
    }
  })
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CompositePath

Nom Description Valeur
commande Ordre de tri pour les chemins composites. 'croissant'
'décroissant'
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur 'Hash'
'MultiHash'
'Range'
Chemins Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés string[]
Version Indique la version de la définition de clé de partition Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

ExcludedPath

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
ressource Format JSON standard d’un graphe Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obligatoire)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. Int
conflictResolutionPolicy Stratégie de résolution des conflits pour le graphique. ConflictResolutionPolicy
defaultTtl Durée de vie par défaut Int
id Nom du graphe Gremlin Cosmos DB chaîne (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins d’accès au document dans le graphique IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Nom Description Valeur
Index Liste des index pour ce chemin d’accès Index[]
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde

Index

Nom Description Valeur
Datatype Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Polygon'
'String'
gentil Indique le type d’index. 'Hash'
'Range'
'Spatial'
précision Précision de l’index. -1 est une précision maximale. Int

IndexingPolicy

Nom Description Valeur
Automatique Indique si la stratégie d’indexation est automatique Bool
compositeIndexes Liste des chemins composites CompositePath[][]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. 'cohérent'
'paresseux'
'none'
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/gremlinDatabases
Propriétés Propriétés permettant de créer et de mettre à jour un graphe Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-11-15 »

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
Types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
'LineString'
'MultiPolygon'
'Point'
'Polygon'

Étiquettes

Nom Description Valeur

UniqueKey

Nom Description Valeur
Chemins La liste des chemins d’accès doit être unique pour chaque document du service Azure Cosmos DB string[]

UniqueKeyPolicy

Nom Description Valeur
uniquesKeys Liste des clés uniques sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]