Sdílet prostřednictvím


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

Definice prostředku Bicep

Typ prostředku databaseAccounts/gremlinDatabases/graphs je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, přidejte do šablony následující bicep.

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'
  }
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CompositePath

Jméno Popis Hodnota
objednávka Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ConflictResolutionPolicy

Jméno Popis Hodnota
conflictResolutionPath Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

ContainerPartitionKey

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru string[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

ExcludedPath

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
zdroj Standardní formát JSON grafu Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (povinné)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
conflictResolutionPolicy Zásady řešení konfliktů pro graf. ConflictResolutionPolicy
defaultTtl Výchozí čas k živému provozu Int
id Název grafu Gremlin služby Cosmos DB string (povinné)
indexingPolicy Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v grafu. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů ContainerPartitionKey
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

IndexingPolicy

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest CompositePath[][]
excludedPaths Seznam cest, které se mají vyloučit z indexování ExcludedPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování IncludedPath[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'none'
spatialIndexes Seznam prostorových specifik SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Jméno Popis Hodnota
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: databaseAccounts/gremlinDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

SpatialSpec

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

Visačky

Jméno Popis Hodnota

UniqueKey

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. string[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKey[]

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/gremlinDatabases/graphs je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, přidejte do šablony následující JSON.

{
  "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"
  }
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CompositePath

Jméno Popis Hodnota
objednávka Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ConflictResolutionPolicy

Jméno Popis Hodnota
conflictResolutionPath Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

ContainerPartitionKey

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru string[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

ExcludedPath

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
zdroj Standardní formát JSON grafu Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (povinné)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
conflictResolutionPolicy Zásady řešení konfliktů pro graf. ConflictResolutionPolicy
defaultTtl Výchozí čas k živému provozu Int
id Název grafu Gremlin služby Cosmos DB string (povinné)
indexingPolicy Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v grafu. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů ContainerPartitionKey
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

IndexingPolicy

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest CompositePath[][]
excludedPaths Seznam cest, které se mají vyloučit z indexování ExcludedPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování IncludedPath[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'none'
spatialIndexes Seznam prostorových specifik SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2022-11-15'
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

SpatialSpec

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

Visačky

Jméno Popis Hodnota

UniqueKey

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. string[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKey[]

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API

nasazení do Azure
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API

nasazení do Azure
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/gremlinDatabases/graphs je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, přidejte do šablony následující Terraform.

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"
              ]
            }
          ]
        }
      }
    }
  })
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CompositePath

Jméno Popis Hodnota
objednávka Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ConflictResolutionPolicy

Jméno Popis Hodnota
conflictResolutionPath Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

ContainerPartitionKey

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru string[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

ExcludedPath

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
zdroj Standardní formát JSON grafu Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (povinné)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
conflictResolutionPolicy Zásady řešení konfliktů pro graf. ConflictResolutionPolicy
defaultTtl Výchozí čas k živému provozu Int
id Název grafu Gremlin služby Cosmos DB string (povinné)
indexingPolicy Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v grafu. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů ContainerPartitionKey
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

IndexingPolicy

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest CompositePath[][]
excludedPaths Seznam cest, které se mají vyloučit z indexování ExcludedPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování IncludedPath[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'none'
spatialIndexes Seznam prostorových specifik SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Jméno Popis Hodnota
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts/gremlinDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-11-15

SpatialSpec

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

Visačky

Jméno Popis Hodnota

UniqueKey

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. string[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKey[]