Microsoft.DocumentDB-DatenbankAccounts/gremlinDatenbanken 2024-05-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/gremlinDatabases kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/gremlinDatabases-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-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'
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/gremlinDatabases

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep 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
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: databaseAccounts
properties Eigenschaften zum Erstellen und Aktualisieren der Gremlin-Datenbank von Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (erforderlich)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Das JSON-Standardformat einer Gremlin-Datenbank GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (erforderlich)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. 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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der Cosmos DB-Gremlin-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API

Bereitstellen in Azure		 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 Gremlin-API-Skalierung

Bereitstellen in Azure		 Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen unter Verwendung des automatischen Skalierungsdurchsatzes.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/gremlinDatabases kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2024-05-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"
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/gremlinDatabases

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"
apiVersion Die Version der Ressourcen-API '2024-05-15'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 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.
properties Eigenschaften zum Erstellen und Aktualisieren einer Gremlin-Datenbank in Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (erforderlich)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Das JSON-Standardformat einer Gremlin-Datenbank GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (erforderlich)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. 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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der Cosmos DB Gremlin-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API

Bereitstellen in Azure		 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

Bereitstellen in Azure		 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 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-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-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"
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/gremlinDatabases

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15"
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: databaseAccounts
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.
properties Eigenschaften zum Erstellen und Aktualisieren der Gremlin-Datenbank von Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (erforderlich)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Das JSON-Standardformat einer Gremlin-Datenbank GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (erforderlich)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. 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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. "Standard"
"Wiederherstellen"
id Name der Cosmos DB-Gremlin-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge