Поделиться через

База данных Microsoft.DocumentDBAccounts/gremlinDatabases 2023-11-15-preview

  • Статья

Определение ресурсов Bicep

Тип ресурса databaseAccounts/gremlinDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ресурс Стандартный формат JSON базы данных Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (обязательно)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"PointInTimeRestore"
"Восстановить"
идентификатор Имя базы данных Gremlin Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ManagedServiceIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Имя Описание Ценность
тождество Удостоверение ресурса. ManagedServiceIdentity
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: databaseAccounts
свойства Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна

Теги

Имя Описание Ценность

Примеры краткого руководства

Следующие примеры краткого руководства по развертыванию этого типа ресурса.

Bicep-файл Описание
Создание учетной записи Azure Cosmos DB для API Gremlin Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью.
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования.

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/gremlinDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2023-11-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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ресурс Стандартный формат JSON базы данных Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (обязательно)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"PointInTimeRestore"
"Восстановить"
идентификатор Имя базы данных Gremlin Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ManagedServiceIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Имя Описание Ценность
apiVersion Версия API '2023-11-15-preview'
тождество Удостоверение ресурса. ManagedServiceIdentity
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна

Теги

Имя Описание Ценность

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание учетной записи Azure Cosmos DB для API Gremlin

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью.
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/gremlinDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, добавьте следующий объект Terraform в шаблон.

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

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ресурс Стандартный формат JSON базы данных Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (обязательно)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"PointInTimeRestore"
"Восстановить"
идентификатор Имя базы данных Gremlin Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

ManagedServiceIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Имя Описание Ценность
тождество Удостоверение ресурса. ManagedServiceIdentity
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
свойства Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-11-15-preview"

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна

Теги

Имя Описание Ценность