Microsoft.Compute virtualMachines/extensions

• Актуальная
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

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

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

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

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

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

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

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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'
  }
}

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

virtualMachines/extensions

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
location	Расположение ресурса	строка
tags	Теги ресурсов	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В 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[]
подсостояние	Сведения о состоянии ресурса.	InstanceViewStatus[]
тип	Указывает тип расширения; пример : CustomScriptExtension.	строка
typeHandlerVersion	Указывает версию обработчика скрипта.	строка

InstanceViewStatus

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

KeyVaultSecretReference

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

SubResource

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

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

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

Шаблон	Описание
Создание виртуальной машины Windows с включенным расширением защиты от вредоносных программ	Этот шаблон создает виртуальную машину Windows и настраивает защиту от вредоносных программ
Сервер IIS с расширением DSC на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает сервер IIS с помощью расширения DSC. Обратите внимание, что при использовании службы хранилища Azure модулю конфигурации DSC требуется передать маркер SAS. Для ссылки на модуль DSC из GitHub (по умолчанию в этом шаблоне) эта ссылка не требуется.
Расширение виртуальной машины ESET	Создание виртуальной машины с расширением ESET
McAfee Endpoint Security (пробная лицензия) на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает пробную версию McAfee Endpoint Security.
Развертывание виртуальной машины Ubuntu с помощью расширения OMS	Этот шаблон позволяет развернуть виртуальную машину Ubuntu с расширением OMS, установленным и подключенным к указанной рабочей области.
Развертывание виртуальной машины Windows с помощью расширения OMS	Этот шаблон позволяет развернуть виртуальную машину Windows с расширением OMS, установленным и подключенным к указанной рабочей области.
Пробная версия расширения Symantec Endpoint Protection на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает пробную версию Symantec Endpoint Protection.
Расширение пользовательских скриптов на виртуальной машине Ubuntu	Этот шаблон создает виртуальную машину Ubuntu и устанавливает расширение CustomScript.
Расширение исправлений ОС на виртуальной машине Ubuntu	Этот шаблон создает виртуальную машину Ubuntu и устанавливает расширение OSPatching.
Развертывание виртуальной машины Windows уровня "Премиум" с помощью диагностика	Этот шаблон позволяет развернуть виртуальную машину Windows ценовой категории "Премиум", используя несколько различных вариантов для версии Windows, используя последнюю исправленную версию.
Развертывание простой виртуальной машины Windows с помощью мониторинга и диагностика	Этот шаблон позволяет развернуть простую виртуальную машину Windows вместе с расширением диагностика, которое обеспечивает мониторинг и диагностика для виртуальной машины.
Использование расширений скриптов для установки Базы данных Mongo на виртуальной машине Ubuntu	Этот шаблон развертывает конфигурации и устанавливает Mongo DB на виртуальной машине Ubuntu в двух отдельных скриптах. Этот шаблон является хорошим примером, демонстрирующим, как выразить зависимости между двумя скриптами, работающими на одной виртуальной машине. Этот шаблон также развертывает учетную запись хранения, виртуальная сеть, общедоступные IP-адреса и сетевой интерфейс.

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

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

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

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

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

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

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
  }
}

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

virtualMachines/extensions

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Compute/virtualMachines/extensions
версия_API	Версия API ресурсов	'2023-09-01'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
location	Расположение ресурса	строка
tags	Теги ресурсов	Словарь имен и значений тегов. См . раздел Теги в шаблонах
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

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

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

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

Шаблон	Описание
Создание виртуальной машины Windows с включенным расширением защиты от вредоносных программ	Этот шаблон создает виртуальную машину Windows и настраивает защиту от вредоносных программ.
Сервер IIS, использующий расширение DSC на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает сервер IIS с помощью расширения DSC. Обратите внимание, что модуль конфигурации DSC должен передавать маркер SAS, если вы используете службу хранилища Azure. Для ссылки на модуль DSC из GitHub (по умолчанию в этом шаблоне) это не требуется.
Расширение виртуальной машины ESET	Создание виртуальной машины с расширением ESET
McAfee Endpoint Security (пробная лицензия) на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает пробную версию McAfee Endpoint Security.
Развертывание виртуальной машины Ubuntu с помощью расширения OMS	Этот шаблон позволяет развернуть виртуальную машину Ubuntu с расширением OMS, установленным и подключенным к указанной рабочей области.
Развертывание виртуальной машины Windows с помощью расширения OMS	Этот шаблон позволяет развернуть виртуальную машину Windows с расширением OMS, установленным и подключенным к указанной рабочей области.
Пробная версия расширения Symantec Endpoint Protection на виртуальной машине Windows	Этот шаблон создает виртуальную машину Windows и настраивает пробную версию Symantec Endpoint Protection.
Расширение пользовательских скриптов на виртуальной машине Ubuntu	Этот шаблон создает виртуальную машину Ubuntu и устанавливает расширение CustomScript.
Расширение исправлений ОС на виртуальной машине Ubuntu	Этот шаблон создает виртуальную машину Ubuntu и устанавливает расширение OSPatching.
Развертывание виртуальной машины Windows уровня "Премиум" с помощью диагностика	Этот шаблон позволяет развернуть виртуальную машину Windows уровня "Премиум" с помощью нескольких различных вариантов для версии Windows, используя последнюю версию с исправлениями.
Развертывание простой виртуальной машины Windows с мониторингом и диагностика	Этот шаблон позволяет развернуть простую виртуальную машину Windows вместе с расширением диагностика, которое обеспечивает мониторинг и диагностика для виртуальной машины.
Использование расширений скриптов для установки Базы данных Mongo на виртуальной машине Ubuntu	Этот шаблон развертывает и устанавливает Mongo DB на виртуальной машине Ubuntu в двух отдельных скриптах. Этот шаблон является хорошим примером, демонстрирующим, как выразить зависимости между двумя скриптами, работающими на одной виртуальной машине. Этот шаблон также развертывает учетную запись хранения, виртуальная сеть, общедоступные IP-адреса и сетевой интерфейс.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
    }
  })
}

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

virtualMachines/extensions

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Compute/virtualMachines/extensions@2023-09-01"
name	имя ресурса.	string (обязательно)
location	Расположение ресурса	строка
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: virtualMachines
tags	Теги ресурсов	Словарь имен и значений тегов.
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

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