Delen via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2024-09-01-preview

  • Artikel

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor 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@2024-09-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (vereist)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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 voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
ouder 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 de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: databaseAccounts
Eigenschappen Eigenschappen voor het maken en bijwerken van de Gremlin-database van Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

ResourceRestoreParameters

Naam Beschrijving 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} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

Tags

Naam Beschrijving Waarde

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand 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 automatische schaalaanpassing van doorvoer.

Resourcedefinitie van ARM-sjabloon

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

Zie logboek wijzigenvoor 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": "2024-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (vereist)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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 voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Naam Beschrijving Waarde
apiVersion De API-versie '2024-09-01-preview'
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van de Gremlin-database van Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'

ResourceRestoreParameters

Naam Beschrijving 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} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

Tags

Naam Beschrijving Waarde

Quickstart-sjablonen

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

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

implementeren in 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's

implementeren in 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 automatische schaalaanpassing van doorvoer.

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor 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@2024-09-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een Gremlin-database GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (vereist)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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 voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts
Eigenschappen Eigenschappen voor het maken en bijwerken van de Gremlin-database van Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-09-01-preview"

ResourceRestoreParameters

Naam Beschrijving 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} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

Tags

Naam Beschrijving Waarde