Share via

Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2023-03-01

  • Статья

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

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

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

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

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, добавьте в шаблон следующий Bicep.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01' = {
  name: 'string'
  location: 'string'
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

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

virtualMachineScaleSets/virtualMachines/extensions

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

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа : virtualMachines
properties Описывает свойства расширения виртуальной машины. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Имя Описание Значение
autoUpgradeMinorVersion Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. bool
enableAutomaticUpgrade Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения. bool
forceUpdateTag Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась. строка
instanceView Представление экземпляра расширения виртуальной машины. VirtualMachineExtensionInstanceView
protectedSettings Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров. Для Bicep можно использовать функцию any().
protectedSettingsFromKeyVault Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей. KeyVaultSecretReference
provisionAfterExtensions Коллекция имен расширений, после которых необходимо подготовить это расширение. string[]
publisher Имя издателя обработчика расширений. строка
Параметры Общедоступные параметры расширения в формате JSON. Для Bicep можно использовать функцию any().
suppressFailures Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. bool
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

VirtualMachineExtensionInstanceView

Имя Описание Значение
name Имя расширения виртуальной машины. строка
statuses Сведения о состоянии ресурса. InstanceViewStatus[]
substatuses Сведения о состоянии ресурса. InstanceViewStatus[]
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

InstanceViewStatus

Имя Описание Значение
code Код состояния. строка
displayStatus Короткая локализуемая метка состояния. строка
уровень Код уровня. "Ошибка"
"Информация"
"Предупреждение"
message Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. строка
time Время состояния. строка

KeyVaultSecretReference

Имя Описание Значение
secretUrl URL-адрес, ссылающийся на секрет в Key Vault. string (обязательно)
sourceVault Относительный URL-адрес Key Vault, содержащий секрет. SubResource (обязательно)

SubResource

Имя Описание Значение
идентификатор Идентификатор ресурса строка

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

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

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

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

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2023-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

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

virtualMachineScaleSets/virtualMachines/extensions

Имя Описание Значение
тип Тип ресурса Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions
версия_API Версия API ресурсов '2023-03-01'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 string (обязательно)
location Расположение расширения. строка
properties Описывает свойства расширения виртуальной машины. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Имя Описание Значение
autoUpgradeMinorVersion Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. bool
enableAutomaticUpgrade Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения. bool
forceUpdateTag Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась. строка
instanceView Представление экземпляра расширения виртуальной машины. VirtualMachineExtensionInstanceView
protectedSettings Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.
protectedSettingsFromKeyVault Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей. KeyVaultSecretReference
provisionAfterExtensions Коллекция имен расширений, после которых необходимо подготовить это расширение. string[]
publisher Имя издателя обработчика расширений. строка
Параметры Общедоступные параметры расширения в формате JSON.
suppressFailures Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. bool
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

VirtualMachineExtensionInstanceView

Имя Описание Значение
name Имя расширения виртуальной машины. строка
statuses Сведения о состоянии ресурса. InstanceViewStatus[]
подсостояние Сведения о состоянии ресурса. InstanceViewStatus[]
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

InstanceViewStatus

Имя Описание Значение
code Код состояния. строка
displayStatus Короткая локализуемая метка для состояния. строка
уровень Код уровня. "Ошибка"
"Информация"
Предупреждение
message Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. строка
time Время состояния. строка

KeyVaultSecretReference

Имя Описание Значение
secretUrl URL-адрес, ссылающийся на секрет в Key Vault. строка (обязательно)
sourceVault Относительный URL-адрес Key Vault, содержащего секрет. SubResource (обязательно)

SubResource

Имя Описание Значение
идентификатор Идентификатор ресурса строка

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

Тип ресурса virtualMachineScaleSets/virtualMachines/extensions можно развернуть с помощью следующих операций:

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

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

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

Чтобы создать ресурс Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

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

virtualMachineScaleSets/virtualMachines/extensions

Имя Описание Значение
тип Тип ресурса "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01"
name имя ресурса. строка (обязательно)
location Расположение расширения. строка
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа virtualMachines
properties Описывает свойства расширения виртуальной машины. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Имя Описание Значение
autoUpgradeMinorVersion Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. bool
enableAutomaticUpgrade Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения. bool
forceUpdateTag Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась. строка
instanceView Представление экземпляра расширения виртуальной машины. VirtualMachineExtensionInstanceView
protectedSettings Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.
protectedSettingsFromKeyVault Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей. KeyVaultSecretReference
provisionAfterExtensions Коллекция имен расширений, после которых необходимо подготовить это расширение. string[]
publisher Имя издателя обработчика расширений. строка
Параметры Общедоступные параметры расширения в формате JSON.
suppressFailures Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. bool
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

VirtualMachineExtensionInstanceView

Имя Описание Значение
name Имя расширения виртуальной машины. строка
statuses Сведения о состоянии ресурса. InstanceViewStatus[]
substatuses Сведения о состоянии ресурса. InstanceViewStatus[]
тип Указывает тип расширения; пример : CustomScriptExtension. строка
typeHandlerVersion Указывает версию обработчика скрипта. строка

InstanceViewStatus

Имя Описание Значение
code Код состояния. строка
displayStatus Короткая локализуемая метка состояния. строка
уровень Код уровня. "Ошибка"
"Информация"
"Предупреждение"
message Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. строка
time Время состояния. строка

KeyVaultSecretReference

Имя Описание Значение
secretUrl URL-адрес, ссылающийся на секрет в Key Vault. string (обязательно)
sourceVault Относительный URL-адрес Key Vault, содержащий секрет. SubResource (обязательно)

SubResource

Имя Описание Значение
идентификатор Идентификатор ресурса строка