Microsoft.DocumentDB-databaseAccounts/gremlinDatabases/graphs 2023-11-15-preview
- Laatste
- 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
Bicep-resourcedefinitie
Het resourcetype databaseAccounts/gremlinDatabases/graphs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-11-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'
]
}
]
}
}
}
}
Eigenschapswaarden
databaseAccounts/gremlinDatabases/graphs
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: gremlinDatabases |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van De Gremlin-grafiek van Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | De standaard-JSON-indeling van een Gremlin-grafiek | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (vereist) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. Opmerking: doorvoer of automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Vertegenwoordigt de maximale doorvoer, zodat de resource omhoog kan worden geschaald. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageTtl | Analytische TTL. | int |
| conflictResolutionPolicy | Het conflictoplossingsbeleid voor de grafiek. | ConflictResolutionPolicy |
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'PointInTimeRestore' 'Herstellen' |
| defaultTtl | Standaard time to live | int |
| id | Naam van de Cosmos DB Gremlin-grafiek | tekenreeks (vereist) |
| indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de grafiek | IndexingPolicy |
| partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
| uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Naam | Description | Waarde |
|---|---|---|
| conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
| conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
| mode | Geeft de conflictoplossingsmodus aan. | 'Aangepast' 'LastWriterWins' |
IndexingPolicy
| Naam | Description | Waarde |
|---|---|---|
| automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
| compositeIndexen | Lijst met samengestelde padlijst | CompositePath[] |
| excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
| includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
| indexingMode | Geeft de indexeringsmodus aan. | 'consistent' 'lui' 'geen' |
| spatialIndexen | Lijst met ruimtelijke details | SpatialSpec[] |
CompositePath
| Naam | Description | Waarde |
|---|---|---|
| order | Sorteervolgorde voor samengestelde paden. | 'oplopend' 'aflopend' |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
ExcludedPath
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
IncludedPath
| Naam | Description | Waarde |
|---|---|---|
| Indexen | Lijst met indexen voor dit pad | Indexen[] |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
Indexen
| Naam | Description | Waarde |
|---|---|---|
| dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | 'LineString' 'MultiPolygon' 'Getal' 'Punt' 'Veelhoek' 'Tekenreeks' |
| Soort | Geeft het type index aan. | Hash 'Bereik' 'Ruimtelijk' |
| precisie | De precisie van de index. -1 is maximale precisie. | int |
SpatialSpec
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
| typen | Lijst met het ruimtelijke type van het pad | Tekenreeksmatrix met een van de volgende: 'LineString' 'MultiPolygon' 'Punt' 'Veelhoek' |
ContainerPartitionKey
| Naam | Description | Waarde |
|---|---|---|
| Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie) ondersteund voor het maken van containers | Hash 'MultiHash' 'Bereik' |
| Paden | Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
| versie | Geeft de versie van de definitie van de partitiesleutel aan | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2 |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Het tijdstip waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
UniqueKeyPolicy
| Naam | Description | Waarde |
|---|---|---|
| uniqueKeys | Lijst met unieke sleutels op die de uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
| Naam | Description | Waarde |
|---|---|---|
| Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Een Azure Cosmos DB-account maken voor Gremlin-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer. |
| Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van gremlin-API's |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van doorvoer voor automatische schaalaanpassing. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts/gremlinDatabases/graphs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2023-11-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" ]
}
]
}
}
}
}
Eigenschapswaarden
databaseAccounts/gremlinDatabases/graphs
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs' |
| apiVersion | De resource-API-versie | '2023-11-15-preview' |
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van De Gremlin-grafiek van Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | De standaard-JSON-indeling van een Gremlin-grafiek | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (vereist) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Naam | Description | Waarde |
|---|---|---|
| instellingen voor automatisch schalen | Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of Automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Staat voor maximale doorvoer, de resource kan omhoog worden geschaald. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageTtl | Analytische TTL. | int |
| conflictResolutionPolicy | Het conflictoplossingsbeleid voor de grafiek. | ConflictResolutionPolicy |
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'PointInTimeRestore' 'Herstellen' |
| defaultTtl | Standaard time to live | int |
| id | Naam van de Cosmos DB Gremlin-grafiek | tekenreeks (vereist) |
| indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de grafiek | IndexingPolicy |
| partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
| uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Naam | Description | Waarde |
|---|---|---|
| conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
| conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
| mode | Geeft de conflictoplossingsmodus aan. | 'Aangepast' 'LastWriterWins' |
IndexingPolicy
| Naam | Description | Waarde |
|---|---|---|
| automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
| compositeIndexen | Lijst met samengestelde padlijst | CompositePath[] |
| excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
| includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
| indexingMode | Geeft de indexeringsmodus aan. | 'consistent' 'lui' 'geen' |
| spatialIndexen | Lijst met ruimtelijke details | SpatialSpec[] |
CompositePath
| Naam | Description | Waarde |
|---|---|---|
| order | Sorteervolgorde voor samengestelde paden. | 'oplopend' 'aflopend' |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
ExcludedPath
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
IncludedPath
| Naam | Description | Waarde |
|---|---|---|
| Indexen | Lijst met indexen voor dit pad | Indexen[] |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
Indexen
| Naam | Description | Waarde |
|---|---|---|
| dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | 'LineString' 'MultiPolygon' 'Getal' 'Punt' 'Veelhoek' 'Tekenreeks' |
| Soort | Geeft het type index aan. | Hash 'Bereik' 'Ruimtelijk' |
| precisie | De precisie van de index. -1 is maximale precisie. | int |
SpatialSpec
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
| typen | Lijst met het ruimtelijke type van het pad | Tekenreeksmatrix met een van de volgende: 'LineString' 'MultiPolygon' 'Punt' 'Veelhoek' |
ContainerPartitionKey
| Naam | Description | Waarde |
|---|---|---|
| Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie) ondersteund voor het maken van containers | Hash 'MultiHash' 'Bereik' |
| Paden | Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
| versie | Geeft de versie van de definitie van de partitiesleutel aan | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2 |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Het tijdstip waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
UniqueKeyPolicy
| Naam | Description | Waarde |
|---|---|---|
| uniqueKeys | Lijst met unieke sleutels op die de uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
| Naam | Description | Waarde |
|---|---|---|
| Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Een Azure Cosmos DB-account maken voor Gremlin-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer. |
| Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van Gremlin-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van doorvoer voor automatische schaalaanpassing. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype databaseAccounts/gremlinDatabases/graphs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-11-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"
]
}
]
}
}
}
})
}
Eigenschapswaarden
databaseAccounts/gremlinDatabases/graphs
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-11-15-preview" |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: gremlinDatabases |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB Gremlin-grafiek. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | Matrix met gebruikersidentiteits-id's. |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | De standaard-JSON-indeling van een Gremlin-grafiek | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (vereist) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. Opmerking: doorvoer of automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Staat voor maximale doorvoer, de resource kan omhoog worden geschaald. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageTtl | Analytische TTL. | int |
| conflictResolutionPolicy | Het conflictoplossingsbeleid voor de grafiek. | ConflictResolutionPolicy |
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | "Standaard" "PointInTimeRestore" "Herstellen" |
| defaultTtl | Standaard time to live | int |
| id | Naam van de Cosmos DB Gremlin-grafiek | tekenreeks (vereist) |
| indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de grafiek | IndexingPolicy |
| partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
| uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Naam | Description | Waarde |
|---|---|---|
| conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
| conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
| mode | Geeft de conflictoplossingsmodus aan. | "Aangepast" "LastWriterWins" |
IndexingPolicy
| Naam | Description | Waarde |
|---|---|---|
| automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
| compositeIndexen | Lijst met samengestelde padlijst | CompositePath[] |
| excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
| includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
| indexingMode | Geeft de indexeringsmodus aan. | "consistent" "lui" "geen" |
| spatialIndexen | Lijst met ruimtelijke details | SpatialSpec[] |
CompositePath
| Naam | Description | Waarde |
|---|---|---|
| order | Sorteervolgorde voor samengestelde paden. | "oplopend" "aflopend" |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
ExcludedPath
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
IncludedPath
| Naam | Description | Waarde |
|---|---|---|
| Indexen | Lijst met indexen voor dit pad | Indexen[] |
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
Indexen
| Naam | Description | Waarde |
|---|---|---|
| dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | "Lijntekenreeks" "MultiPolygon" "Getal" "Punt" "Veelhoek" "Tekenreeks" |
| Soort | Geeft het type index aan. | "Hash" "Bereik" "Ruimtelijk" |
| precisie | De precisie van de index. -1 is maximale precisie. | int |
SpatialSpec
| Naam | Description | Waarde |
|---|---|---|
| leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
| typen | Lijst met het ruimtelijke type van het pad | Tekenreeksmatrix met een van de volgende: "Lijntekenreeks" "MultiPolygon" "Punt" "Veelhoek" |
ContainerPartitionKey
| Naam | Description | Waarde |
|---|---|---|
| Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie) ondersteund voor het maken van containers | "Hash" "MultiHash" "Bereik" |
| Paden | Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
| versie | Geeft de versie van de definitie van de partitiesleutel aan | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2 |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Het tijdstip waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
UniqueKeyPolicy
| Naam | Description | Waarde |
|---|---|---|
| uniqueKeys | Lijst met unieke sleutels op die de uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
| Naam | Description | Waarde |
|---|---|---|
| Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |