Microsoft.DocumentDB databaseAccounts/apis/databases/graphs 2016-03-19
Definicja zasobu Bicep
Typ zasobu databaseAccounts/apis/databases/graphs można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-19' = {
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'
]
}
]
}
}
}
}
Wartości właściwości
databaseAccounts/apis/databases/graphs
Nazwa | Opis | Wartość |
---|---|---|
name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
Nadrzędny | W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Symboliczna nazwa zasobu typu: bazy danych |
properties | Właściwości do tworzenia i aktualizowania grafu Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (wymagane) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. | CreateUpdateOptions (wymagane) |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResource (wymagane) |
CreateUpdateOptions
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ciąg |
GremlinGraphResource
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
defaultTtl | Domyślny czas wygaśnięcia | int |
identyfikator | Nazwa grafu Języka Gremlin w usłudze Cosmos DB | ciąg (wymagany) |
indexingPolicy | Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w grafie | IndexingPolicy |
partitionKey | Konfiguracja klucza partycji do użycia do partycjonowania danych na wiele partycji | ContainerPartitionKey |
uniqueKeyPolicy | Unikatowa konfiguracja zasad klucza do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
excludedPaths | Lista ścieżek do wykluczenia z indeksowania | ExcludedPath[] |
includedPaths | Lista ścieżek do uwzględnienia w indeksowaniu | IncludedPath[] |
indexingMode | Wskazuje tryb indeksowania. | "Spójne" "Leniwy" "Brak" |
Wykluczona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
dataType | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania | "Skrót" "Zakres" |
Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości w dokumentach w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/apis/databases/graphs można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
"apiVersion": "2016-03-19",
"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" ]
}
]
}
}
}
}
Wartości właściwości
databaseAccounts/apis/databases/graphs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs" |
apiVersion | Wersja interfejsu API zasobów | '2016-03-19' |
name | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON. |
ciąg (wymagany) |
properties | Właściwości do tworzenia i aktualizowania grafu Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (wymagane) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. | CreateUpdateOptions (wymagane) |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResource (wymagane) |
CreateUpdateOptions
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ciąg |
GremlinGraphResource
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
defaultTtl | Domyślny czas wygaśnięcia | int |
identyfikator | Nazwa grafu Języka Gremlin w usłudze Cosmos DB | ciąg (wymagany) |
indexingPolicy | Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w grafie | IndexingPolicy |
partitionKey | Konfiguracja klucza partycji do użycia do partycjonowania danych na wiele partycji | ContainerPartitionKey |
uniqueKeyPolicy | Unikatowa konfiguracja zasad klucza do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
excludedPaths | Lista ścieżek do wykluczenia z indeksowania | ExcludedPath[] |
includedPaths | Lista ścieżek do uwzględnienia w indeksowaniu | IncludedPath[] |
indexingMode | Wskazuje tryb indeksowania. | "Spójne" "Leniwy" "Brak" |
Wykluczona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
dataType | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania | "Skrót" "Zakres" |
Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | ciąg[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy wymuszających ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/apis/databases/graphs można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-19"
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"
]
}
]
}
}
}
})
}
Wartości właściwości
databaseAccounts/apis/databases/graphs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-19" |
name | Nazwa zasobu | ciąg (wymagany) |
parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: bazy danych |
properties | Właściwości do tworzenia i aktualizowania grafu gremlin usługi Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (wymagane) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptions (wymagane) |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResource (wymagane) |
CreateUpdateOptions
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ciąg |
GremlinGraphResource
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
defaultTtl | Domyślny czas wygaśnięcia | int |
identyfikator | Nazwa grafu Języka Gremlin usługi Cosmos DB | ciąg (wymagany) |
indexingPolicy | Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w grafie | IndexingPolicy |
partitionKey | Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji | ContainerPartitionKey |
uniqueKeyPolicy | Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowe" "LastWriterWins" |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
excludedPaths | Lista ścieżek do wykluczenia z indeksowania | ExcludedPath[] |
includedPaths | Lista ścieżek do uwzględnienia w indeksowaniu | IncludedPath[] |
indexingMode | Wskazuje tryb indeksowania. | "Spójne" "Leniwy" "Brak" |
Wykluczona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
dataType | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania | "Skrót" "Zakres" |
Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości w dokumentach w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |