Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2021-04-01-preview
- Neueste
- 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
- 15.03.2023
- 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
- 15.06.2021
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15.1.2021
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-Ressourcendefinition
Der Ressourcentyp databaseAccounts/gremlinDatabases/graphs kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-01-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: {
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: '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
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Eigenschaftswerte
databaseAccounts/gremlinDatabases/graphs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ : gremlinDatabases |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren eines Gremlin-Graphen in Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" 'SystemAssigned,UserAssigned' "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Das JSON-Standardformat eines Gremlin-Graphen | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (erforderlich) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Conflictresolutionpolicy | Die Konfliktlösungsrichtlinie für das Diagramm. | Conflictresolutionpolicy |
| defaultTtl | Standardzeit für die Lebzeit | INT |
| id | Name des Gremlin-Graphen von Cosmos DB | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade innerhalb des Graphen automatisch. | IndexingPolicy |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey |
| uniqueKeyPolicy | Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy |
Conflictresolutionpolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktauflösungspfad im Fall des LastWriterWins-Modus. | Zeichenfolge |
| conflictResolutionProcedure | Die Prozedur zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. | Zeichenfolge |
| Modus | Gibt den Konfliktauflösungsmodus an. | "Benutzerdefiniert" "LastWriterWins" |
IndexingPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| automatic | Gibt an, ob die Indizierungsrichtlinie automatisch erfolgt. | bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath[] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath[] |
| includedPaths | Liste der Pfade, die in die Indizierung einbezogen werden sollen | IncludedPath[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" "keine" |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
CompositePath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| order | Sortierreihenfolge für zusammengesetzte Pfade. | "aufsteigend" "absteigend" |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
ExcludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
IncludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Indizes | Liste der Indizes für diesen Pfad | Indizes[] |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
Indizes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| dataType | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | 'LineString' "MultiPolygon" "Zahl" "Punkt" "Polygon" "String" |
| kind | Gibt den Indextyp an. | "Hash" "Bereich" "Spatial" |
| precision (Genauigkeit) | Die Genauigkeit des Indexes. -1 ist die maximale Genauigkeit. | INT |
SpatialSpec
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
| types | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das eines der folgenden Elemente enthält: 'LineString' "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| kind | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt. | "Hash" "MultiHash" "Bereich" |
| Pfade | Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können | string[] |
| version | Gibt die Version der Partitionsschlüsseldefinition an. | INT Einschränkungen: Minimaler Wert = 1 Max. Wert = 2 |
UniqueKeyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. | UniqueKey[] |
UniqueKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Pfade | Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die automatische Skalierung der Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mithilfe des automatischen Skalierungsdurchsatzes erstellt. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp databaseAccounts/gremlinDatabases/graphs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2021-04-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "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"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Eigenschaftswerte
databaseAccounts/gremlinDatabases/graphs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" |
| apiVersion | Die Ressourcen-API-Version | "2021-04-01-preview" |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren des Gremlin-Graphen von Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Das JSON-Standardformat eines Gremlin-Diagramms | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (erforderlich) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Conflictresolutionpolicy | Die Konfliktlösungsrichtlinie für das Diagramm. | Conflictresolutionpolicy |
| defaultTtl | Standardzeit | INT |
| id | Name des Cosmos DB Gremlin-Graphen | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade innerhalb des Diagramms automatisch. | IndexingPolicy |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey |
| uniqueKeyPolicy | Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy |
Conflictresolutionpolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktlösungspfad im Fall des LastWriterWins-Modus. | Zeichenfolge |
| conflictResolutionProcedure | Das Verfahren zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. | Zeichenfolge |
| Modus | Gibt den Konfliktlösungsmodus an. | "Benutzerdefiniert" "LastWriterWins" |
IndexingPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| automatic | Gibt an, ob die Indizierungsrichtlinie automatisch ist. | bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath[] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath[] |
| includedPaths | Liste der Pfade, die in die Indizierung einbezogen werden sollen | IncludedPath[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" "keine" |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
CompositePath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| order | Sortierreihenfolge für zusammengesetzte Pfade. | "Aufsteigend" "absteigend" |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) | Zeichenfolge |
ExcludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) | Zeichenfolge |
IncludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Indizes | Liste der Indizes für diesen Pfad | Indizes[] |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) | Zeichenfolge |
Indizes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| dataType | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | 'LineString' "MultiPolygon" "Zahl" "Punkt" "Polygon" 'Zeichenfolge' |
| kind | Gibt den Indextyp an. | "Hash" "Bereich" "Räumlicher Raum" |
| precision (Genauigkeit) | Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. | INT |
SpatialSpec
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) | Zeichenfolge |
| types | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das folgendes enthält: 'LineString' "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| kind | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt. | "Hash" "MultiHash" "Bereich" |
| Pfade | Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können | string[] |
| version | Gibt die Version der Partitionsschlüsseldefinition an. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 2 |
UniqueKeyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. | UniqueKey[] |
UniqueKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Pfade | Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die automatische Skalierung der Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mithilfe des automatischen Skalierungsdurchsatzes erstellt. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp databaseAccounts/gremlinDatabases/graphs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-01-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 = {
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "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
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Eigenschaftswerte
databaseAccounts/gremlinDatabases/graphs
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: gremlinDatabases |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren eines Gremlin-Graphen in Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Array von Benutzeridentitäts-IDs. |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Das JSON-Standardformat eines Gremlin-Graphen | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (erforderlich) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Conflictresolutionpolicy | Die Konfliktlösungsrichtlinie für das Diagramm. | Conflictresolutionpolicy |
| defaultTtl | Standardzeit für die Lebzeit | INT |
| id | Name des Gremlin-Graphen von Cosmos DB | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade innerhalb des Graphen automatisch. | IndexingPolicy |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey |
| uniqueKeyPolicy | Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy |
Conflictresolutionpolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktauflösungspfad im Fall des LastWriterWins-Modus. | Zeichenfolge |
| conflictResolutionProcedure | Die Prozedur zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. | Zeichenfolge |
| Modus | Gibt den Konfliktauflösungsmodus an. | "Custom" "LastWriterWins" |
IndexingPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| automatic | Gibt an, ob die Indizierungsrichtlinie automatisch erfolgt. | bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath[] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath[] |
| includedPaths | Liste der Pfade, die in die Indizierung einbezogen werden sollen | IncludedPath[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" "keine" |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
CompositePath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| order | Sortierreihenfolge für zusammengesetzte Pfade. | "Aufsteigend" "absteigend" |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
ExcludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
IncludedPath
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Indizes | Liste der Indizes für diesen Pfad | Indizes[] |
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
Indizes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| dataType | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | "LineString" "MultiPolygon" "Zahl" "Punkt" "Polygon" "String" |
| kind | Gibt den Indextyp an. | "Hash" "Bereich" "Spatial" |
| precision (Genauigkeit) | Die Genauigkeit des Indexes. -1 ist die maximale Genauigkeit. | INT |
SpatialSpec
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| path | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) | Zeichenfolge |
| types | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das eines der folgenden Elemente enthält: "LineString" "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| kind | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt. | "Hash" "MultiHash" "Bereich" |
| Pfade | Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können | string[] |
| version | Gibt die Version der Partitionsschlüsseldefinition an. | INT Einschränkungen: Minimaler Wert = 1 Max. Wert = 2 |
UniqueKeyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. | UniqueKey[] |
UniqueKey
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Pfade | Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |