Set-AzVMCustomScriptExtension
Добавляет в виртуальную машину расширение пользовательского скрипта.
Синтаксис
ByNameWithContainerAndFileNamesParameterSet (по умолчанию)
Set-AzVMCustomScriptExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-ContainerName <String>
-FileName <String[]>
[-Name <String>]
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByNameWithFileUriParameterSet
Set-AzVMCustomScriptExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectWithContainerAndFileNamesParameterSet
Set-AzVMCustomScriptExtension
-Name <String>
-VMObject <PSVirtualMachine>
-ContainerName <String>
-FileName <String[]>
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectWithFileUriParameterSet
Set-AzVMCustomScriptExtension
-Name <String>
-VMObject <PSVirtualMachine>
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceIdWithContainerAndFileNamesParameterSet
Set-AzVMCustomScriptExtension
-ResourceId <String>
-ContainerName <String>
-FileName <String[]>
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceIdWithFileUriParameterSet
Set-AzVMCustomScriptExtension
-ResourceId <String>
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzVMCustomScriptExtension
-InputObject <VirtualMachineCustomScriptExtensionContext>
-ContainerName <String>
-FileName <String[]>
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzVMCustomScriptExtension
-InputObject <VirtualMachineCustomScriptExtensionContext>
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Set-AzVMCustomScriptExtension добавляет в виртуальную машину расширение настраиваемой виртуальной машины скрипта.
Это расширение позволяет запускать собственные скрипты на виртуальной машине.
Примеры
Пример 1. Добавление пользовательского скрипта
Set-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"
Эта команда добавляет настраиваемый скрипт на виртуальную машину с именем VirtualMachine07.
Файл скрипта contososcript.exe.
Пример 2
Добавляет в виртуальную машину расширение пользовательского скрипта. (autogenerated)
Set-AzVMCustomScriptExtension -Argument <String> -ContainerName 'Scripts' -DefaultProfile <IAzureContextContainer> -FileName 'ContosoScript.exe' -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -Run 'myScript.ps1' -SecureExecution -StorageAccountKey <String> -StorageAccountName 'Contoso' -TypeHandlerVersion '1.1' -VMName 'VirtualMachine07'
Параметры
-Argument
Указывает аргументы, которые расширение скрипта передает в скрипт.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
Тип: SwitchParameter
Default value: False
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: cf
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ContainerName
Указывает имя контейнера хранилища Azure, в котором этот командлет хранит скрипт.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.
Свойства параметра
Тип: IAzureContextContainer
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-DisableAutoUpgradeMinorVersion
Командлет Set-AzVMCustomScriptExtension добавляет в виртуальную машину расширение настраиваемой виртуальной машины скрипта.
Это расширение позволяет запускать собственные скрипты на виртуальной машине.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-FileName
Указывает имя файла скрипта. Если файл хранится в хранилище BLOB-объектов Azure, значение имени файла учитывает регистр. Имена файлов, хранящихся в хранилище файлов Azure, не учитывает регистр.
Свойства параметра
Тип: String [ ]
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-FileUri
Задает универсальный код ресурса (URI) файла скрипта.
Свойства параметра
Тип: String [ ]
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithFileUriParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-ForceRerun
Указывает, что этот командлет принудительно выполняет повторное выполнение той же конфигурации расширения на виртуальной машине без удаления и переустановки расширения.
Значение может быть любой строкой, отличной от текущего значения.
Если forceUpdateTag не изменяется, обновления общедоступных или защищенных параметров по-прежнему применяются обработчиком.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
Объект расширения виртуальной машины.
ByInputObjectWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByInputObjectWithFileUriParameterSet
Position: Named
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Location
Указывает расположение виртуальной машины.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-Name
Указывает имя расширения пользовательского скрипта.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: ExtensionName
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByNameWithFileUriParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-NoWait
Запускает операцию и возвращается немедленно перед завершением операции. Чтобы определить, успешно ли выполнена операция, используйте другой механизм.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceGroupName
Указывает имя группы ресурсов виртуальной машины.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByNameWithFileUriParameterSet
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-ResourceId
Идентификатор ресурса расширения виртуальной машины.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByResourceIdWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByResourceIdWithFileUriParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-Run
Указывает команду, используемую для запуска скрипта.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: RunFile, командование
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-SecureExecution
Указывает, что этот командлет гарантирует, что значение параметра запуска не регистрируется на сервере или возвращается пользователю с помощью API расширения GET.
Значение Запуска может содержать секреты или пароли, передаваемые в файл скрипта безопасно.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-StorageAccountKey
Указывает ключ для контейнера хранилища Azure.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-StorageAccountName
Указывает имя учетной записи хранения Azure, в которой этот командлет хранит скрипт.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-StorageEndpointSuffix
Указывает суффикс конечной точки хранилища.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-TypeHandlerVersion
Указывает версию расширения, используемого для этой виртуальной машины.
Чтобы получить версию, выполните командлет Get-AzVMExtensionImage со значением параметра PublisherName и CustomScriptExtension для параметра Type .
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: HandlerVersion, Версия
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-VMName
Указывает имя виртуальной машины.
Этот командлет добавляет расширение пользовательского скрипта для виртуальной машины, указанной этим параметром.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: ИмяРесурса
Наборы параметров
ByNameWithContainerAndFileNamesParameterSet
Position: 1
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ByNameWithFileUriParameterSet
Position: 1
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-VMObject
Объект виртуальной машины.
Свойства параметра
Тип: PSVirtualMachine
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByParentObjectWithContainerAndFileNamesParameterSet
Position: Named
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByParentObjectWithFileUriParameterSet
Position: Named
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-WhatIf
Показывает, что произойдет, если командлет будет запущен.
Командлет не запускается.
Свойства параметра
Тип: SwitchParameter
Default value: False
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: wi
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters .
Выходные данные