Microsoft.Compute virtualMachines/extensions 2023-09-01

Статья
08/17/2024

Определение ресурсов 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

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

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

Имя	Описание	Ценность
код	Код состояния.	струна
displayStatus	Короткая локализуемая метка для состояния.	струна
уровень	Код уровня.	"Ошибка" "Info" Предупреждение
Сообщение	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.	струна
Время	Время состояния.	струна

KeyVaultSecretReference

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

SubResource

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

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

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

Шаблон	Описание
создание виртуальной машины Windows с поддержкой расширения защиты от вредоносных программ развертывание	Этот шаблон создает виртуальную машину Windows и настраивает защиту от вредоносных программ
IIS Server с помощью расширения 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 DB на виртуальной машине 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"
apiVersion	Версия API ресурсов	'2023-09-01'
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.	строка (обязательно)
местоположение	Расположение ресурса	струна
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
свойства	Описывает свойства расширения виртуальной машины.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

Имя	Описание	Ценность
код	Код состояния.	струна
displayStatus	Короткая локализуемая метка для состояния.	струна
уровень	Код уровня.	"Ошибка" "Info" Предупреждение
Сообщение	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.	струна
Время	Время состояния.	струна

KeyVaultSecretReference

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

SubResource

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

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

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

Шаблон	Описание
создание виртуальной машины Windows с поддержкой расширения защиты от вредоносных программ развертывание	Этот шаблон создает виртуальную машину Windows и настраивает защиту от вредоносных программ
IIS Server с помощью расширения 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 DB на виртуальной машине 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"
имя	Имя ресурса	строка (обязательно)
местоположение	Расположение ресурса	струна
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: virtualMachines
Теги	Теги ресурсов	Словарь имен и значений тегов.
свойства	Описывает свойства расширения виртуальной машины.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

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

VirtualMachineExtensionInstanceView

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

InstanceViewStatus

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

KeyVaultSecretReference

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

SubResource

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

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

Microsoft.Compute virtualMachines/extensions 2023-09-01

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

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

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

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

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

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

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

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

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

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

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

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

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

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

Обратная связь

Дополнительные ресурсы