Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2024-02-15-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych Języka Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (wymagane)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"PointInTimeRestore"
"Przywracanie"
id Nazwa bazy danych Języka Gremlin usługi Cosmos DB ciąg (wymagany)
restoreParameters Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania bazy danych Języka Gremlin w usłudze Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} struna
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). struna
restoreWithTtlDisabled Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności.
Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych Języka Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (wymagane)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"PointInTimeRestore"
"Przywracanie"
id Nazwa bazy danych Języka Gremlin usługi Cosmos DB ciąg (wymagany)
restoreParameters Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-02-15-preview"
tożsamość Tożsamość zasobu. ManagedServiceIdentity
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania bazy danych Języka Gremlin w usłudze Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} struna
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). struna
restoreWithTtlDisabled Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności.
Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/gremlinDatabases można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych Języka Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (wymagane)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"PointInTimeRestore"
"Przywracanie"
id Nazwa bazy danych Języka Gremlin usługi Cosmos DB ciąg (wymagany)
restoreParameters Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania bazy danych Języka Gremlin w usłudze Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-02-15-preview"

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} struna
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). struna
restoreWithTtlDisabled Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość