Dela via


Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2020-04-01

Bicep-resursdefinition

Resurstypen databaseAccounts/gremlinDatabases/graphs kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01' = {
  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'
  }
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CompositePath

Namn Beskrivning Värde
ordning Sorteringsordning för sammansatta sökvägar. "Stigande"
"Fallande"
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure Proceduren för att lösa konflikter när det gäller anpassat läge. sträng
läge Anger konfliktlösningsläget. "Anpassad"
"LastWriterWins"

ContainerPartitionKey

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

ExcludedPath

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (krävs)
resurs JSON-standardformatet för en Gremlin-graf GremlinGraphResourceOrGremlinGraphGetPropertiesResource (krävs)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för diagrammet. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namn på Cosmos DB Gremlin-grafen sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i diagrammet IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

IncludedPath

Namn Beskrivning Värde
Index Lista över index för den här sökvägen Index[]
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

Index

Namn Beskrivning Värde
Datatyp Den datatyp som indexeringsbeteendet tillämpas på. "LineString"
"MultiPolygon"
"Tal"
"Punkt"
"Polygon"
"Sträng"
sort Anger typen av index. "Hash"
"Intervall"
"Rumslig"
precision Indexets precision. -1 är maximal precision. Int

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes Lista över lista över sammansatta sökvägar CompositePath[][]
excludedPaths Lista över sökvägar som ska undantas från indexering ExcludedPath[]
includedPaths Lista över sökvägar som ska inkluderas i indexeringen IncludedPath[]
indexingMode Anger indexeringsläget. "Konsekvent"
"Lat"
"Ingen"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Namn Beskrivning Värde
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.
Symboliskt namn för resurs av typen: databaseAccounts/gremlinDatabases
Egenskaper Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

SpatialSpec

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng
Typer Lista över sökvägens rumsliga typ Strängmatris som innehåller något av:
"LineString"
"MultiPolygon"
"Punkt"
"Polygon"

Taggar

Namn Beskrivning Värde

UniqueKey

Namn Beskrivning Värde
Sökvägar Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten string[]

UniqueKeyPolicy

Namn Beskrivning Värde
uniqueKeys Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKey[]

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa ett Azure Cosmos DB-konto för Gremlin API- Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med hjälp av dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Autoskalning av Gremlin API Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med autoskalningsdataflöde.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/gremlinDatabases/graphs kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2020-04-01",
  "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"
  }
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CompositePath

Namn Beskrivning Värde
ordning Sorteringsordning för sammansatta sökvägar. "Stigande"
"Fallande"
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure Proceduren för att lösa konflikter när det gäller anpassat läge. sträng
läge Anger konfliktlösningsläget. "Anpassad"
"LastWriterWins"

ContainerPartitionKey

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

ExcludedPath

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (krävs)
resurs JSON-standardformatet för en Gremlin-graf GremlinGraphResourceOrGremlinGraphGetPropertiesResource (krävs)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för diagrammet. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namn på Cosmos DB Gremlin-grafen sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i diagrammet IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

IncludedPath

Namn Beskrivning Värde
Index Lista över index för den här sökvägen Index[]
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

Index

Namn Beskrivning Värde
Datatyp Den datatyp som indexeringsbeteendet tillämpas på. "LineString"
"MultiPolygon"
"Tal"
"Punkt"
"Polygon"
"Sträng"
sort Anger typen av index. "Hash"
"Intervall"
"Rumslig"
precision Indexets precision. -1 är maximal precision. Int

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes Lista över lista över sammansatta sökvägar CompositePath[][]
excludedPaths Lista över sökvägar som ska undantas från indexering ExcludedPath[]
includedPaths Lista över sökvägar som ska inkluderas i indexeringen IncludedPath[]
indexingMode Anger indexeringsläget. "Konsekvent"
"Lat"
"Ingen"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Namn Beskrivning Värde
apiVersion API-versionen '2020-04-01'
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs"

SpatialSpec

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng
Typer Lista över sökvägens rumsliga typ Strängmatris som innehåller något av:
"LineString"
"MultiPolygon"
"Punkt"
"Polygon"

Taggar

Namn Beskrivning Värde

UniqueKey

Namn Beskrivning Värde
Sökvägar Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten string[]

UniqueKeyPolicy

Namn Beskrivning Värde
uniqueKeys Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKey[]

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skapa ett Azure Cosmos DB-konto för Gremlin API-

Distribuera till Azure
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med hjälp av dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Autoskalning av Gremlin API

Distribuera till Azure
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med autoskalningsdataflöde.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/gremlinDatabases/graphs kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01"
  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"
              ]
            }
          ]
        }
      }
    }
  })
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CompositePath

Namn Beskrivning Värde
ordning Sorteringsordning för sammansatta sökvägar. "Stigande"
"Fallande"
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure Proceduren för att lösa konflikter när det gäller anpassat läge. sträng
läge Anger konfliktlösningsläget. "Anpassad"
"LastWriterWins"

ContainerPartitionKey

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

ExcludedPath

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (krävs)
resurs JSON-standardformatet för en Gremlin-graf GremlinGraphResourceOrGremlinGraphGetPropertiesResource (krävs)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för diagrammet. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namn på Cosmos DB Gremlin-grafen sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i diagrammet IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

IncludedPath

Namn Beskrivning Värde
Index Lista över index för den här sökvägen Index[]
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng

Index

Namn Beskrivning Värde
Datatyp Den datatyp som indexeringsbeteendet tillämpas på. "LineString"
"MultiPolygon"
"Tal"
"Punkt"
"Polygon"
"Sträng"
sort Anger typen av index. "Hash"
"Intervall"
"Rumslig"
precision Indexets precision. -1 är maximal precision. Int

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes Lista över lista över sammansatta sökvägar CompositePath[][]
excludedPaths Lista över sökvägar som ska undantas från indexering ExcludedPath[]
includedPaths Lista över sökvägar som ska inkluderas i indexeringen IncludedPath[]
indexingMode Anger indexeringsläget. "Konsekvent"
"Lat"
"Ingen"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Namn Beskrivning Värde
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts/gremlinDatabases
Egenskaper Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01"

SpatialSpec

Namn Beskrivning Värde
stig Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) sträng
Typer Lista över sökvägens rumsliga typ Strängmatris som innehåller något av:
"LineString"
"MultiPolygon"
"Punkt"
"Polygon"

Taggar

Namn Beskrivning Värde

UniqueKey

Namn Beskrivning Värde
Sökvägar Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten string[]

UniqueKeyPolicy

Namn Beskrivning Värde
uniqueKeys Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKey[]