База данных Microsoft.DocumentDBAccounts/mongodbDatabases/collections/throughputSettings 2022-02-15-preview

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

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

databaseAccounts/mongodbDatabases/collections/throug...

Имя Описание Значение
name имя ресурса.

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: collections
удостоверение Удостоверение ресурса. Управляемое удостоверение службы
properties Свойства для обновления пропускной способности ресурсов Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (обязательно)

Управляемое удостоверение службы

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настраиваемое свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Имя Описание Значение
ресурс Стандартный формат JSON для пропускной способности ресурса ThroughputSettingsResourceOrThroughputSettingsGetPro... (обязательно)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Имя Описание Значение
autoscaleSettings Ресурс Cosmos DB для параметров автомасштабирования. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. AutoscaleSettingsResource
throughput Значение пропускной способности ресурса Cosmos DB. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. INT

AutoscaleSettingsResource

Имя Описание Значение
autoUpgradePolicy Политика автоматического обновления ресурсов Cosmos DB AutoUpgradePolicyResource
maxThroughput Представляет максимальную пропускную способность, которую может масштабировать контейнер. int (обязательно)

AutoUpgradePolicyResource

Имя Описание Значение
throughputPolicy Представляет политику пропускной способности, которой должна соответствовать служба для автоматического обновления. ThroughputPolicyResource

ThroughputPolicyResource

Имя Описание Значение
incrementPercent Представляет процент, на который пропускная способность может увеличиваться при каждом запуске политики пропускной способности. INT
isEnabled Определяет, активна ли throughputPolicy. bool

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2022-02-15-preview",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

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

databaseAccounts/mongodbDatabases/collections/throug...

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings
версия_API Версия API ресурсов '15.02.2022-preview'
name имя ресурса.

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

Управляемое удостоверение службы

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Имя Описание Значение
ресурс Стандартный формат JSON для пропускной способности ресурса ThroughputSettingsResourceOrThroughputSettingsGetPro... (обязательно)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Имя Описание Значение
autoscaleSettings Ресурс Cosmos DB для параметров автомасштабирования. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. AutoscaleSettingsResource
throughput Значение пропускной способности ресурса Cosmos DB. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. INT

AutoscaleSettingsResource

Имя Описание Значение
autoUpgradePolicy Политика автоматического обновления ресурсов Cosmos DB AutoUpgradePolicyResource
maxThroughput Представляет максимальную пропускную способность, которую может масштабировать контейнер. int (обязательно)

AutoUpgradePolicyResource

Имя Описание Значение
throughputPolicy Представляет политику пропускной способности, которой должна соответствовать служба для автоматического обновления. ThroughputPolicyResource

ThroughputPolicyResource

Имя Описание Значение
incrementPercent Представляет процент, на который пропускная способность может увеличиваться при каждом запуске политики пропускной способности. INT
isEnabled Определяет, активна ли throughputPolicy. bool

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

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

databaseAccounts/mongodbDatabases/collections/throug...

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

Управляемое удостоверение службы

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Имя Описание Значение
ресурс Стандартный формат JSON для пропускной способности ресурса ThroughputSettingsResourceOrThroughputSettingsGetPro... (обязательно)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Имя Описание Значение
autoscaleSettings Ресурс Cosmos DB для параметров автомасштабирования. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. AutoscaleSettingsResource
throughput Значение пропускной способности ресурса Cosmos DB. Требуется пропускная способность или параметр autoscaleSettings, но не оба этих параметра. INT

AutoscaleSettingsResource

Имя Описание Значение
autoUpgradePolicy Политика автоматического обновления ресурсов Cosmos DB AutoUpgradePolicyResource
maxThroughput Представляет максимальную пропускную способность, которую может масштабировать контейнер. int (обязательно)

AutoUpgradePolicyResource

Имя Описание Значение
throughputPolicy Представляет политику пропускной способности, которой должна соответствовать служба для автоматического обновления. ThroughputPolicyResource

ThroughputPolicyResource

Имя Описание Значение
incrementPercent Представляет процент, на который пропускная способность может увеличиваться при каждом запуске политики пропускной способности. INT
isEnabled Определяет, активна ли throughputPolicy. bool