Sdílet prostřednictvím

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

  • Článek

Definice prostředku Bicep

Typ prostředku databaseAccounts/gremlinDatabases je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, přidejte do šablony následující bicep.

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

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zdroj Standardní formát JSON databáze Gremlin GremlinDatabaseResourceResourceOrGremlinDatabaseGetPropertiesResource (povinné)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Jméno Popis Hodnota
createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
id Název databáze Gremlin služby Cosmos DB string (povinné)
restoreParameters Parametry označující informace o obnovení ResourceRestoreParameters

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze Gremlin služby Azure Cosmos DB GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

ResourceRestoreParameters

Jméno Popis Hodnota
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Visačky

Jméno Popis Hodnota

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/gremlinDatabases je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zdroj Standardní formát JSON databáze Gremlin GremlinDatabaseResourceResourceOrGremlinDatabaseGetPropertiesResource (povinné)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Jméno Popis Hodnota
createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
id Název databáze Gremlin služby Cosmos DB string (povinné)
restoreParameters Parametry označující informace o obnovení ResourceRestoreParameters

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2024-12-01-preview
identita Identita prostředku ManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze Gremlin služby Azure Cosmos DB GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

ResourceRestoreParameters

Jméno Popis Hodnota
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Visačky

Jméno Popis Hodnota

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/gremlinDatabases je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zdroj Standardní formát JSON databáze Gremlin GremlinDatabaseResourceResourceOrGremlinDatabaseGetPropertiesResource (povinné)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Jméno Popis Hodnota
createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
id Název databáze Gremlin služby Cosmos DB string (povinné)
restoreParameters Parametry označující informace o obnovení ResourceRestoreParameters

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze Gremlin služby Azure Cosmos DB GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-12-01-preview

ResourceRestoreParameters

Jméno Popis Hodnota
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Visačky

Jméno Popis Hodnota