Share via

Microsoft.DocumentDB-databaseAccounts/gremlinDatabases 2023-11-15

  • Artikel

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/gremlinDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
}

Eigenschapswaarden

databaseAccounts/gremlinDatabases

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 (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. 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: databaseAccounts
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB Gremlin-database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (vereist)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource De standaard-JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (vereist)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Naam Description Waarde
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
id Naam van de Cosmos DB Gremlin-database tekenreeks (vereist)
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters

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 Tijd waarop het account moet worden hersteld (ISO-8601-indeling). tekenreeks

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een Azure Cosmos DB-account maken voor Gremlin-API

Implementeren op Azure		 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

Implementeren op Azure		 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 kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2023-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  }
}

Eigenschapswaarden

databaseAccounts/gremlinDatabases

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'
apiVersion De resource-API-versie '2023-11-15'
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 (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. Tags in sjablonen bekijken
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB Gremlin-database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (vereist)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource De standaard-JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (vereist)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Naam Description Waarde
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
id Naam van de Cosmos DB Gremlin-database tekenreeks (vereist)
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters

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 Tijd waarop het account moet worden hersteld (ISO-8601-indeling). tekenreeks

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een Azure Cosmos DB-account maken voor Gremlin-API

Implementeren op Azure		 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

Implementeren op Azure		 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 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 wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

Eigenschapswaarden

databaseAccounts/gremlinDatabases

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-15"
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: databaseAccounts
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.
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB Gremlin-database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (vereist)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource De standaard-JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (vereist)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Naam Description Waarde
createMode Opsomming om de modus voor het maken van resources aan te geven. "Standaard"
"Herstellen"
id Naam van de Cosmos DB Gremlin-database tekenreeks (vereist)
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters

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