Microsoft.DocumentDB databasAccounts/gremlinDatabases 2022-05-15-preview

Bicep-resursdefinition

Resurstypen databaseAccounts/gremlinDatabases kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2022-05-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Namn Beskrivning Värde
identitet Identitet för resursen. ManagedServiceIdentity (HanteradServiceIdentitet)
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: databaseAccounts
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB Gremlin-databasen. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

AutoskalningInställningar

Namn Beskrivning Värde
max-genomströmning Representerar maximalt dataflöde, resursen kan skalas upp till. Int

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings (autoskalning) Anger inställningarna för autoskalning. AutoskalningInställningar
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
resurs JSON-standardformatet för en Gremlin-databas GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (krävs)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Namn Beskrivning Värde
Id Namn på Cosmos DB Gremlin-databasen sträng (krävs)

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
användartilldelade identiteter Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde

Användningsexempel

Bicep-exempel

Ett grundläggande exempel på hur du distribuerar Gremlin-databasen i ett Cosmos DB-konto.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: [
      {
        name: 'EnableGremlin'
      }
    ]
    consistencyPolicy: {
      defaultConsistencyLevel: 'Strong'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource gremlinDatabase 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-04-15' = {
  name: resourceName
  parent: databaseAccount
  properties: {
    options: {}
    resource: {
      id: resourceName
    }
  }
}

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil Beskrivning
Skapa ett Azure Cosmos DB-konto för Gremlin API- Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med hjälp av dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Autoskalning av Gremlin API Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med autoskalningsdataflöde.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/gremlinDatabases kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2022-05-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Namn Beskrivning Värde
apiVersion API-versionen "2022-05-15-preview"
identitet Identitet för resursen. ManagedServiceIdentity (HanteradServiceIdentitet)
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB Gremlin-databasen. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"

AutoskalningInställningar

Namn Beskrivning Värde
max-genomströmning Representerar maximalt dataflöde, resursen kan skalas upp till. Int

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings (autoskalning) Anger inställningarna för autoskalning. AutoskalningInställningar
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
resurs JSON-standardformatet för en Gremlin-databas GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (krävs)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Namn Beskrivning Värde
Id Namn på Cosmos DB Gremlin-databasen sträng (krävs)

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
användartilldelade identiteter Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Skapa ett Azure Cosmos DB-konto för Gremlin API-

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med hjälp av dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Autoskalning av Gremlin API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med autoskalningsdataflöde.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/gremlinDatabases kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/gremlinDatabases-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2022-05-15-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Namn Beskrivning Värde
identitet Identitet för resursen. ManagedServiceIdentity (HanteradServiceIdentitet)
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
föräldra_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB Gremlin-databasen. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2022-05-15-preview"

AutoskalningInställningar

Namn Beskrivning Värde
max-genomströmning Representerar maximalt dataflöde, resursen kan skalas upp till. Int

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings (autoskalning) Anger inställningarna för autoskalning. AutoskalningInställningar
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
resurs JSON-standardformatet för en Gremlin-databas GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (krävs)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Namn Beskrivning Värde
Id Namn på Cosmos DB Gremlin-databasen sträng (krävs)

ManagedServiceIdentity (HanteradServiceIdentitet)

Namn Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
användartilldelade identiteter Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på hur du distribuerar Gremlin-databasen i ett Cosmos DB-konto.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
        {
          name = "EnableGremlin"
        },
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "gremlinDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-04-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on