Partager via


Base de données Microsoft.DocumentDBAccounts/gremlinDatabases/graphs 2020-03-01

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 des ressources

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      throughput: 'string'
      {customized property}: 'string'
    }
    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'
            ]
          }
        ]
      }
    }
  }
}

Valeurs de propriétés

databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.
chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent Dans Bicep, vous pouvez spécifier la ressource parente pour 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 : gremlinDatabases
properties Propriétés permettant de créer et de mettre à jour un graphique Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatoire)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... (obligatoire)
resource Format JSON standard d’un graphe Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Nom Description Valeur
throughput Unités de requête par seconde. Par exemple, « débit » : « 10000 ». string
{propriété personnalisée} string

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Nom Description Valeur
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 string (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 les données en plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. 'Personnalisé'
'LastWriterWins'

IndexingPolicy

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

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. 'Croissant'
'Décroissant'
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

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

IncludedPath

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

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Nombre'
'Point'
'Polygon'
'String'
kind Indique le type d'index. 'Hachage'
'Range'
'Spatial'
précision Précision de l’index. -1 est une précision maximale. int

SpatialSpec

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string
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'

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement 'Hachage'
'Range'
chemins d'accès Liste des chemins d’accès à l’aide des données du conteneur qui 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

UniqueKeyPolicy

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

UniqueKey

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

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’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 d’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 ressources 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 des ressources

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": "2020-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "throughput": "string",
      "{customized property}": "string"
    },
    "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" ]
          }
        ]
      }
    }
  }
}

Valeurs de propriétés

databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs »
apiVersion Version de l’API de ressource '2020-03-01'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.
chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés permettant de créer et de mettre à jour un graphique Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatoire)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... (obligatoire)
resource Format JSON standard d’un graphique Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Nom Description Valeur
throughput Unités de requête par seconde. Par exemple, « débit » : « 10000 ». string
{propriété personnalisée} string

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Nom Description Valeur
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 string (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 les données en plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. 'Personnalisé'
'LastWriterWins'

IndexingPolicy

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

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. 'Croissant'
'Décroissant'
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

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

IncludedPath

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

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Nombre'
'Point'
'Polygon'
'String'
kind Indique le type d'index. 'Hash'
'Range'
'Spatial'
précision Précision de l’index. -1 correspond à la précision maximale. int

SpatialSpec

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string
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'

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement 'Hash'
'Range'
chemins d'accès Liste des chemins d’accès utilisant les données du conteneur qui 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

UniqueKeyPolicy

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

UniqueKey

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

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’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 utilisant le 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 d’API, consultez journal des modifications.

Format des ressources

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@2020-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        throughput = "string"
        {customized property} = "string"
      }
      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"
              ]
            }
          ]
        }
      }
    }
  })
}

Valeurs de propriétés

databaseAccounts/gremlinDatabases/graphs

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01 »
name Nom de la ressource chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : gremlinDatabases
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés permettant de créer et de mettre à jour un graphique Gremlin Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatoire)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... (obligatoire)
resource Format JSON standard d’un graphe Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Nom Description Valeur
throughput Unités de requête par seconde. Par exemple, « débit » : « 10000 ». string
{propriété personnalisée} string

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Nom Description Valeur
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 de document dans le graphique IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner les données dans plusieurs partitions ContainerPartitionKey
uniqueKeyPolicy Configuration de stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. "Custom"
« LastWriterWins »

IndexingPolicy

Nom Description Valeur
automatique Indique si la stratégie d’indexation est automatique bool
compositeIndexes Liste de chemins composites CompositePath[]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins d’accès à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. « Cohérent »
« Paresseux »
"None"
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. « Croissant »
« Décroissant »
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

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

IncludedPath

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

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. « LineString »
« MultiPolygon »
« Nombre »
« Point »
« Polygone »
« String »
kind Indique le type d'index. « Hachage »
« Plage »
« Spatial »
précision Précision de l’index. -1 est une précision maximale. int

SpatialSpec

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

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement « Hachage »
« Plage »
chemins d'accès Liste des chemins d’accès à l’aide des données du conteneur qui 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

UniqueKeyPolicy

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

UniqueKey

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