База данных Microsoft.DocumentDBAccounts/gremlinDatabases

• Актуальная
• 2024-05-15
• 15.05.2024 г.
• 15.02.2024 г.
• 2023-11-15
• 15.11.2023 г.
• 2023-09-15
• 15.09.2023 г.
• 2023-04-15
• 2023-03-15
• 15.03.2023 г.
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022 г.
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022 г.
• 15.11.2021-preview
• 2021-10-15
• 15.10.2021 г.
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 01.08.2019

Определение ресурса Bicep

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

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
}

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

databaseAccounts/gremlinDatabases

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа databaseAccounts
properties	Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB.	GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (обязательно)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется пропускная способность или autoscaleSettings, но не оба этих параметра.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

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

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

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

ResourceRestoreParameters

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

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

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

Шаблон	Описание
Создание учетной записи 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": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  }
}

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

databaseAccounts/gremlinDatabases

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/gremlinDatabases
версия_API	Версия API ресурсов	'2024-05-15'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB.	GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (обязательно)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется пропускная способность или autoscaleSettings, но не оба этих параметра.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

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

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность. Ресурс может масштабироваться до .	INT

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

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

ResourceRestoreParameters

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

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

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

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

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

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

• Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

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

databaseAccounts/gremlinDatabases

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15"
name	имя ресурса.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: databaseAccounts
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов.
properties	Свойства для создания и обновления базы данных Gremlin в Azure Cosmos DB.	GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (обязательно)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеПараметры, но не оба.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

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

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность. Ресурс может масштабироваться до .	INT

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

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

ResourceRestoreParameters

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