Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2023-03-15-preview
- Najnowsza
- 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ć 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/gremlinDatabases/graphs, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-03-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
]
}
]
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Wartości właściwości
databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
Nadrzędny | 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: gremlinDatabases |
identity | Tożsamość zasobu. | ManagedServiceIdentity |
properties | Właściwości do tworzenia i aktualizowania grafu gremlin usługi Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (wymagane) |
ManagedServiceIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
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" "PointInTimeRestore" "Przywróć" |
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 |
restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
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 |
compositeIndexes | 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" "none" |
spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
CompositePath
Nazwa | Opis | Wartość |
---|---|---|
kolejność | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
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 |
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 |
SpatialSpec
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 |
types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash wiele kluczy partycji (maksymalnie trzy) jest obsługiwanych w przypadku tworzenia kontenerów | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
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} | ciąg |
restoreTimestampInUtc | Czas przywrócenia konta (format ISO-8601). | 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[] |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | 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 dla 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 skalowania automatycznego. |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/gremlinDatabases/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/gremlinDatabases/graphs, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2023-03-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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" ]
}
]
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Wartości właściwości
databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" |
apiVersion | Wersja interfejsu API zasobów | "2023-03-15-preview" |
name | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON. |
ciąg (wymagany) |
location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
identity | Tożsamość zasobu. | Identyfikator usługi zarządzanej |
properties | Właściwości do tworzenia i aktualizowania grafu Gremlin w usłudze Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (wymagane) |
Identyfikator usługi zarządzanej
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
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" "PointInTimeRestore" "Przywróć" |
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 |
restoreParameters | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
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 |
compositeIndexes | 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" "none" |
spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
CompositePath
Nazwa | Opis | Wartość |
---|---|---|
kolejność | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
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 |
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 |
SpatialSpec
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 |
types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash wiele kluczy partycji (maksymalnie trzy) jest obsługiwanych w przypadku tworzenia kontenerów | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
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} | ciąg |
restoreTimestampInUtc | Czas przywrócenia konta (format ISO-8601). | 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[] |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | 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 dla 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 narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/gremlinDatabases/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/gremlinDatabases/graphs, dodaj następujący element Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-03-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
]
}
]
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Wartości właściwości
databaseAccounts/gremlinDatabases/graphs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-03-15-preview" |
name | Nazwa zasobu | ciąg (wymagany) |
location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: gremlinDatabases |
tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. |
identity | Tożsamość zasobu. | ManagedServiceIdentity |
properties | Właściwości do tworzenia i aktualizowania grafu gremlin usługi Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (wymagane) |
ManagedServiceIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej 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. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
identity_ids | 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Tablica identyfikatorów tożsamości użytkowników. |
ManagedServiceIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
Nazwa | Opis | Wartość |
---|---|---|
opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
zasób | Standardowy format JSON grafu Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
Nazwa | Opis | Wartość |
---|---|---|
autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
Nazwa | Opis | Wartość |
---|---|---|
maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
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" "PointInTimeRestore" "Przywróć" |
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 |
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 |
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 |
compositeIndexes | 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 przestrzennych | SpatialSpec[] |
CompositePath
Nazwa | Opis | Wartość |
---|---|---|
kolejność | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "Malejąco" |
path | Ś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 (/path/*) | ciąg |
ExcludedPath
Nazwa | Opis | Wartość |
---|---|---|
path | Ś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 (/path/*) | ciąg |
IncludedPath
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 zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/path/*) | ciąg |
Indeksy
Nazwa | Opis | Wartość |
---|---|---|
dataType | Typ danych, do 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 |
SpatialSpec
Nazwa | Opis | Wartość |
---|---|---|
path | Ś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 (/path/*) | ciąg |
types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
Nazwa | Opis | Wartość |
---|---|---|
Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash w przypadku tworzenia kontenera jest obsługiwanych wiele kluczy partycji (maksymalnie trzy) | "Skrót" "MultiHash" "Zakres" |
Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | ciąg[] |
Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
ResourceRestoreParameters
Nazwa | Opis | Wartość |
---|---|---|
restoreSource | Identyfikator konta bazy danych, z którego ma zostać zainicjowane przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | 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[] |