Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs
- najnowsze
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definicja zasobu Bicep
Typ zasobu databaseAccounts/gremlinDatabases/graphs można wdrożyć przy użyciu operacji docelowych:
- 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 dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-12-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
createMode: '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'
]
}
]
vectorIndexes: [
{
path: 'string'
type: 'string'
}
]
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nazwa | Opis | Wartość |
---|
Ścieżka złożona
Nazwa | Opis | Wartość |
---|---|---|
porządek | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | struna |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | struna |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
rodzaj | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | string[] |
Wersja | Wskazuje wersję definicji klucza partycji | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2 |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
przepustowość | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | Int |
ExcludedPath
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions |
zasób | Standardowy format JSON grafu Języka Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResource (wymagane) |
GremlinGraphResourceOrGremlinGraphGetPropertiesResource
Nazwa | Opis | Wartość |
---|---|---|
analyticalStorageTtl | Analityczny czas wygaśnięcia. | Int |
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "Przywracanie" |
defaultTtl | Domyślny czas wygaśnięcia | Int |
id | Nazwa grafu 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 |
restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
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 |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | indeksy[] |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
Datatype | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
rodzaj | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precyzja | Precyzja indeksu. -1 jest maksymalną precyzją. | Int |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
Automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | Bool |
indeksy złożone | Lista listy ścieżek złożonych | CompositePath[][] |
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" |
spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
vectorIndexes | Lista ścieżek do uwzględnienia w indeksowaniu wektorowym | VectorIndex[] |
ManagedServiceIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
nazwa | Nazwa zasobu | ciąg (wymagany) |
rodzic | W 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. |
Nazwa symboliczna zasobu typu: databaseAccounts/gremlinDatabases |
Właściwości | Właściwości do tworzenia i aktualizowania grafu Języka Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (wymagane) |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
ResourceRestoreParameters
Nazwa | Opis | Wartość |
---|---|---|
restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
restoreWithTtlDisabled | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SpatialSpec
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Typy | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
Tagi
Nazwa | Opis | Wartość |
---|
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
VectorIndex
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka do pola wektora w dokumencie. | ciąg (wymagany) |
typ | Typ indeksu wektora. Obecnie obsługiwane są płaskie, diskANN i kwantyzowaneFlat. | "diskANN" "płaski" "quantizedFlat" (wymagane) |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
Plik Bicep | Opis |
---|---|
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/gremlinDatabases/graphs można wdrożyć przy użyciu operacji docelowych:
- 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 dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2024-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"createMode": "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" ]
}
],
"vectorIndexes": [
{
"path": "string",
"type": "string"
}
]
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nazwa | Opis | Wartość |
---|
Ścieżka złożona
Nazwa | Opis | Wartość |
---|---|---|
porządek | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | struna |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | struna |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
rodzaj | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | string[] |
Wersja | Wskazuje wersję definicji klucza partycji | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2 |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
przepustowość | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | Int |
ExcludedPath
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions |
zasób | Standardowy format JSON grafu Języka Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResource (wymagane) |
GremlinGraphResourceOrGremlinGraphGetPropertiesResource
Nazwa | Opis | Wartość |
---|---|---|
analyticalStorageTtl | Analityczny czas wygaśnięcia. | Int |
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "Przywracanie" |
defaultTtl | Domyślny czas wygaśnięcia | Int |
id | Nazwa grafu 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 |
restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
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 |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | indeksy[] |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
Datatype | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
rodzaj | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precyzja | Precyzja indeksu. -1 jest maksymalną precyzją. | Int |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
Automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | Bool |
indeksy złożone | Lista listy ścieżek złożonych | CompositePath[][] |
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" |
spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
vectorIndexes | Lista ścieżek do uwzględnienia w indeksowaniu wektorowym | VectorIndex[] |
ManagedServiceIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
apiVersion | Wersja interfejsu API | "2024-12-01-preview" |
tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | Właściwości do tworzenia i aktualizowania grafu Języka Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (wymagane) |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" |
ResourceRestoreParameters
Nazwa | Opis | Wartość |
---|---|---|
restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
restoreWithTtlDisabled | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SpatialSpec
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Typy | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
Tagi
Nazwa | Opis | Wartość |
---|
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
VectorIndex
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka do pola wektora w dokumencie. | ciąg (wymagany) |
typ | Typ indeksu wektora. Obecnie obsługiwane są płaskie, diskANN i kwantyzowaneFlat. | "diskANN" "płaski" "quantizedFlat" (wymagane) |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Szablon | Opis |
---|---|
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/gremlinDatabases/graphs można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
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"
}
createMode = "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"
]
}
]
vectorIndexes = [
{
path = "string"
type = "string"
}
]
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Wartości właściwości
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nazwa | Opis | Wartość |
---|
Ścieżka złożona
Nazwa | Opis | Wartość |
---|---|---|
porządek | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
ConflictResolutionPolicy
Nazwa | Opis | Wartość |
---|---|---|
conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | struna |
conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | struna |
tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
rodzaj | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | string[] |
Wersja | Wskazuje wersję definicji klucza partycji | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2 |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
przepustowość | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | Int |
ExcludedPath
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions |
zasób | Standardowy format JSON grafu Języka Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResource (wymagane) |
GremlinGraphResourceOrGremlinGraphGetPropertiesResource
Nazwa | Opis | Wartość |
---|---|---|
analyticalStorageTtl | Analityczny czas wygaśnięcia. | Int |
conflictResolutionPolicy | Zasady rozwiązywania konfliktów dla grafu. | ConflictResolutionPolicy |
createMode | Wyliczenie wskazujące tryb tworzenia zasobów. | "Wartość domyślna" "Przywracanie" |
defaultTtl | Domyślny czas wygaśnięcia | Int |
id | Nazwa grafu 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 |
restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
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 |
Uwzględniona ścieżka
Nazwa | Opis | Wartość |
---|---|---|
Indeksy | Lista indeksów dla tej ścieżki | indeksy[] |
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
Datatype | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
rodzaj | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
precyzja | Precyzja indeksu. -1 jest maksymalną precyzją. | Int |
IndexingPolicy
Nazwa | Opis | Wartość |
---|---|---|
Automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | Bool |
indeksy złożone | Lista listy ścieżek złożonych | CompositePath[][] |
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" |
spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
vectorIndexes | Lista ścieżek do uwzględnienia w indeksowaniu wektorowym | VectorIndex[] |
ManagedServiceIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
nazwa | Nazwa zasobu | ciąg (wymagany) |
parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: databaseAccounts/gremlinDatabases |
Właściwości | Właściwości do tworzenia i aktualizowania grafu Języka Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (wymagane) |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-12-01-preview" |
ResourceRestoreParameters
Nazwa | Opis | Wartość |
---|---|---|
restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
restoreWithTtlDisabled | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SpatialSpec
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) | struna |
Typy | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
Tagi
Nazwa | Opis | Wartość |
---|
UniqueKey
Nazwa | Opis | Wartość |
---|---|---|
Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nazwa | Opis | Wartość |
---|---|---|
uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
VectorIndex
Nazwa | Opis | Wartość |
---|---|---|
ścieżka | Ścieżka do pola wektora w dokumencie. | ciąg (wymagany) |
typ | Typ indeksu wektora. Obecnie obsługiwane są płaskie, diskANN i kwantyzowaneFlat. | "diskANN" "płaski" "quantizedFlat" (wymagane) |