Microsoft.DocumentDB databaseAccounts/apis/databases/graphs 2015-04-08

  • Článek

Definice prostředku Bicep

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

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/apis/databases/graphs, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-08' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/api/databases/graphs

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí 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 : databáze
properties Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (povinné)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
prostředek Standardní formát JSON grafu Gremlin GremlinGraphResource (povinné)

CreateUpdateOptions

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

GremlinGraphResource

Název Description Hodnota
konfliktResolutionPolicy Zásady řešení konfliktů pro graf. KonfliktResolutionPolicy
defaultTtl Výchozí hodnota TTL (Time to Live) int
id Název grafu Gremlin služby Cosmos DB string (povinné)
zásady indexování Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v grafu automatické. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k rozdělení dat do více oddílů Klíč oddílu kontejneru
zásady jedinečného klíče Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

KonfliktResolutionPolicy

Název Description 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'

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli jsou zásady indexování automatické. bool
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í'
Lazy
'Žádný'

ExcludedPath

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

IncludedPath

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. 'LineString'
'MultiPolygon'
'Číslo'
"Bod"
'Mnohoúhelník'
'Řetězec'
Druhu Označuje typ indexu. 'Hash'
'Rozsah'
'Prostorový'
Přesnost Přesnost indexu. -1 je maximální přesnost. int

Klíč oddílu kontejneru

Název Description Hodnota
Druhu Určuje druh algoritmu použitého k dělení. 'Hash'
'Rozsah'
Cesty Seznam cest, pomocí kterých je možné data v kontejneru rozdělit na oddíly string[]

UniqueKeyPolicy

Název Description Hodnota
jedinečné klíče Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB Jedinečný klíč[]

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. string[]

Definice prostředku šablony ARM

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

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/apis/databases/graphs, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
  "apiVersion": "2015-04-08",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/api/databases/graphs

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs
apiVersion Verze rozhraní API prostředku '2015-04-08'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
properties Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (povinné)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
prostředek Standardní formát JSON grafu Gremlin GremlinGraphResource (povinné)

CreateUpdateOptions

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

GremlinGraphResource

Název Description Hodnota
conflictResolutionPolicy Zásady řešení konfliktů pro graf ConflictResolutionPolicy
defaultTtl Výchozí hodnota time to Live int
id Název grafu Gremlin služby Cosmos DB string (povinné)
indexováníZásady Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v grafu automatické. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k rozdělení dat do více oddílů ContainerPartitionKey
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

ConflictResolutionPolicy

Název Description 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'

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli je zásada indexování automatická. bool
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í"
'Líný'
'Žádný'

Vyloučená cesta

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*). řetězec

Zahrnutá cesta

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. 'LineString'
'MultiPolygon'
'Číslo'
"Bod"
'Mnohoúhelník'
'Řetězec'
Druhu Označuje typ indexu. 'Hash'
'Rozsah'
'Prostorové'
Přesnost Přesnost indexu. -1 je maximální přesnost. int

ContainerPartitionKey

Název Description Hodnota
Druhu Označuje druh algoritmu použitého k dělení. 'Hash'
'Rozsah'
Cesty Seznam cest, pomocí kterých je možné dělit data v kontejneru string[]

UniqueKeyPolicy

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

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být jedinečný pro každý dokument ve službě Azure Cosmos DB. string[]

Definice prostředku Terraformu (zprostředkovatele AzAPI)

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

  • 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/apis/databases/graphs, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-08"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Hodnoty vlastností

databaseAccounts/api/databases/graphs

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-08
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databáze
properties Vlastnosti pro vytvoření a aktualizaci grafu Gremlin služby Azure Cosmos DB GremlinGraphVytvořitUpdatePropertiesOrGremlinGraphProp... (povinné)

GremlinGraphVytvořitUpdatePropertiesOrGremlinGraphProp...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se mají použít pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
prostředek Standardní formát JSON grafu Gremlin GremlinGraphResource (povinné)

CreateUpdateOptions

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

GremlinGraphResource

Název Description Hodnota
conflictResolutionPolicy Zásady řešení konfliktů pro graf ConflictResolutionPolicy
defaultTtl Výchozí hodnota time to Live int
id Název grafu Gremlin služby Cosmos DB string (povinné)
indexováníZásady Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v grafu automatické. IndexingPolicy
partitionKey Konfigurace klíče oddílu, který se má použít k rozdělení dat do více oddílů ContainerPartitionKey
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

ConflictResolutionPolicy

Název Description 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"

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli je zásada indexování automatická. bool
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í"
"Líný"
"Žádné"

Vyloučená cesta

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*). řetězec

Zahrnutá cesta

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. "LineString"
"MultiPolygon"
"Číslo"
"Point"
"Mnohoúhelník"
"Řetězec"
Druhu Označuje typ indexu. "Hash"
"Rozsah"
"Prostorové"
Přesnost Přesnost indexu. -1 je maximální přesnost. int

ContainerPartitionKey

Název Description Hodnota
Druhu Označuje druh algoritmu použitého k dělení. "Hash"
"Rozsah"
Cesty Seznam cest, pomocí kterých je možné dělit data v kontejneru string[]

UniqueKeyPolicy

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

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být jedinečný pro každý dokument ve službě Azure Cosmos DB. string[]