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

Set-AzVMExtension

  • Ссылка
Модуль:
Az.Compute

Обновляет свойства расширения или добавляет расширение в виртуальную машину.

Синтаксис

Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет Set-AzVMExtension обновляет свойства существующих расширений виртуальных машин или добавляет расширение в виртуальную машину.

Примеры

Пример 1. Изменение параметров с помощью хэш-таблиц

$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;

Первые две команды используют стандартный синтаксис Windows PowerShell для создания хэш-таблиц, а затем хранят эти хэш-таблицы в $Settings и переменных $ProtectedSettings. Для получения дополнительных сведений введите Get-Help about_Hash_Tables. Вторая команда содержит два значения, созданных ранее и хранящихся в переменных. Последняя команда изменяет расширение виртуальной машины с именем VirtualMachine22 в ResourceGroup11 в соответствии с содержимым $Settings и $ProtectedSettings. Команда указывает другие необходимые сведения, включая издателя и тип расширения.

Пример 2. Изменение параметров с помощью строк

$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;

Первые две команды создают строки, содержащие параметры, а затем хранят их в переменных $SettingsString и $ProtectedSettingsString. Последняя команда изменяет расширение виртуальной машины с именем VirtualMachine22 в ResourceGroup11 в соответствии с содержимым $SettingsString и $ProtectedSettingsString. Команда указывает другие необходимые сведения, включая издателя и тип расширения.

Параметры

-AsJob

Запуск командлета в фоновом режиме

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DisableAutoUpgradeMinorVersion

Указывает, что этот командлет запрещает гостевой агент Azure автоматически обновлять расширения до более новой дополнительной версии. По умолчанию этот командлет позволяет гостевму агенту обновлять расширения.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-EnableAutomaticUpgrade

Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.

Тип:Nullable<T>[Boolean]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ExtensionType

Указывает тип расширения.

Тип:String
Aliases:Type
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ForceRerun

Указывает, что этот командлет принудительно выполняет повторное выполнение той же конфигурации расширения на виртуальной машине без удаления и переустановки расширения. Значение может быть любой строкой, отличной от текущего значения. Если forceUpdateTag не изменяется, обновления общедоступных или защищенных параметров по-прежнему применяются обработчиком.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Location

Указывает расположение виртуальной машины.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Указывает имя расширения.

Тип:String
Aliases:ExtensionName
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-NoWait

Запускает операцию и возвращается немедленно перед завершением операции. Чтобы определить, успешно ли выполнена операция, используйте другой механизм.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ProtectedSettings

Указывает частную конфигурацию расширения в виде хэш-таблицы. Этот командлет шифрует частную конфигурацию.

Тип:Hashtable
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ProtectedSettingString

Указывает частную конфигурацию расширения в виде строки. Этот командлет шифрует частную конфигурацию.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Publisher

Указывает имя издателя расширения. Издатель предоставляет имя, когда издатель регистрирует расширение.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ResourceGroupName

Указывает имя группы ресурсов виртуальной машины.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Settings

Указывает общедоступную конфигурацию расширения в виде хэш-таблицы. Этот командлет не шифрует общедоступную конфигурацию.

Тип:Hashtable
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SettingString

Указывает общедоступную конфигурацию расширения в виде строки. Этот командлет не шифрует общедоступную конфигурацию.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-TypeHandlerVersion

Указывает версию расширения, используемого для этой виртуальной машины.

Тип:String
Aliases:HandlerVersion, Version
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-VMName

Указывает имя виртуальной машины. Этот командлет изменяет расширения для виртуальной машины, указанной этим параметром.

Тип:String
Aliases:ResourceName
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

String

Hashtable

SwitchParameter

Выходные данные

PSAzureOperationResponse