Microsoft.DocumentDB databaseAccounts/apis/databases/graphs
Bicep-resursdefinition
Resurstypen databaseAccounts/apis/databases/graphs kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31' = {
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'
]
}
]
}
}
}
}
Egenskapsvärden
databaseAccounts/apis/databases/graphs
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
| parent | 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 överordnad resurs. |
Symboliskt namn för resurs av typen: databaser |
| properties | Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (krävs) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| Name | Beskrivning | Värde |
|---|---|---|
| alternativ | Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. | CreateUpdateOptions (obligatoriskt) |
| resource | JSON-standardformatet för en Gremlin-graf | GremlinGraphResource (krävs) |
CreateUpdateOptions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | sträng |
GremlinGraphResource
| Name | Beskrivning | Värde |
|---|---|---|
| conflictResolutionPolicy | Konfliktlösningsprincipen för diagrammet. | ConflictResolutionPolicy |
| defaultTtl | Standardtid till live | int |
| id | Namnet 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 unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| conflictResolutionPath | Konfliktlösningssökvägen i fallet LastWriterWins-läge. | sträng |
| conflictResolutionProcedure | Proceduren för att lösa konflikter i ett anpassat läge. | sträng |
| mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
| excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
| includedPaths | Lista över sökvägar som ska ingå i indexeringen | IncludedPath[] |
| indexingMode | Anger indexeringsläget. | "Konsekvent" "Lat" "Ingen" |
ExcludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
IncludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] |
| path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
Index
| Name | Beskrivning | Värde |
|---|---|---|
| dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
| Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
| precision | Precisionen för indexet. -1 är maximal precision. | int |
ContainerPartitionKey
| Name | Beskrivning | Värde |
|---|---|---|
| Typ | 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[] |
UniqueKeyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
| Name | 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[] |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/apis/databases/graphs kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
"apiVersion": "2016-03-31",
"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" ]
}
]
}
}
}
}
Egenskapsvärden
databaseAccounts/apis/databases/graphs
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs" |
| apiVersion | Resurs-API-versionen | '2016-03-31' |
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| properties | Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (krävs) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| Name | Beskrivning | Värde |
|---|---|---|
| alternativ | Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptions (krävs) |
| resource | JSON-standardformatet för en Gremlin-graf | GremlinGraphResource (krävs) |
CreateUpdateOptions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | sträng |
GremlinGraphResource
| Name | Beskrivning | Värde |
|---|---|---|
| conflictResolutionPolicy | Konfliktlösningsprincipen för diagrammet. | ConflictResolutionPolicy |
| defaultTtl | Standardtid att leva | 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 |
ConflictResolutionPolicy
| Name | 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 i ett anpassat läge. | sträng |
| mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
| 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" "Lazy" "Ingen" |
ExcludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| path | 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 |
IncludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] |
| path | 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
| Name | Beskrivning | Värde |
|---|---|---|
| dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
| Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
| precision | Precisionen för indexet. -1 är maximal precision. | int |
ContainerPartitionKey
| Name | Beskrivning | Värde |
|---|---|---|
| Typ | 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[] |
UniqueKeyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
| Name | 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[] |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/apis/databases/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 Resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31"
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"
]
}
]
}
}
}
})
}
Egenskapsvärden
databaseAccounts/apis/databases/graphs
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31" |
| name | 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: databaser |
| properties | Egenskaper för att skapa och uppdatera Gremlin-grafen i Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (krävs) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| Name | Beskrivning | Värde |
|---|---|---|
| alternativ | Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. | CreateUpdateOptions (obligatoriskt) |
| resource | JSON-standardformatet för en Gremlin-graf | GremlinGraphResource (krävs) |
CreateUpdateOptions
| Name | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | sträng |
GremlinGraphResource
| Name | Beskrivning | Värde |
|---|---|---|
| conflictResolutionPolicy | Konfliktlösningsprincipen för diagrammet. | ConflictResolutionPolicy |
| defaultTtl | Standardtid till live | int |
| id | Namnet 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 unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| conflictResolutionPath | Konfliktlösningssökvägen i fallet LastWriterWins-läge. | sträng |
| conflictResolutionProcedure | Proceduren för att lösa konflikter i ett anpassat läge. | sträng |
| mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
| 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" "Lazy" "Ingen" |
ExcludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| path | 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 |
IncludedPath
| Name | Beskrivning | Värde |
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] |
| path | 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
| Name | Beskrivning | Värde |
|---|---|---|
| dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
| Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
| precision | Indexets precision. -1 är maximal precision. | int |
ContainerPartitionKey
| Name | Beskrivning | Värde |
|---|---|---|
| Typ | 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[] |
UniqueKeyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
| Name | 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[] |