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


Set-AzVMCustomScriptExtension

Добавляет в виртуальную машину расширение пользовательского скрипта.

Синтаксис

Set-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <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>]
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>]
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>]
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>]
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>]
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

Добавляет в виртуальную машину расширение пользовательского скрипта. (автоматическое создание)

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

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerName

Указывает имя контейнера хранилища Azure, в котором этот командлет хранит скрипт.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-FileName

Указывает имя файла скрипта. Если файл хранится в хранилище BLOB-объектов Azure, значение имени файла учитывает регистр. Имена файлов, хранящихся в хранилище файлов Azure, не учитывает регистр.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-FileUri

Задает универсальный код ресурса (URI) файла скрипта.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ForceRerun

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Объект расширения виртуальной машины.

Type:VirtualMachineCustomScriptExtensionContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Type:String
Aliases:ExtensionName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoWait

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Идентификатор ресурса расширения виртуальной машины.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Run

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

Type:String
Aliases:RunFile, Command
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SecureExecution

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountKey

Указывает ключ для контейнера хранилища Azure.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountName

Указывает имя учетной записи хранения Azure, в которой этот командлет хранит скрипт.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageEndpointSuffix

Указывает суффикс конечной точки хранилища.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TypeHandlerVersion

Указывает версию расширения, используемого для этой виртуальной машины. Чтобы получить версию, выполните командлет Get-AzVMExtensionImage со значением параметра PublisherName и CustomScriptExtension для параметра Type.

Type:String
Aliases:HandlerVersion, Version
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

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

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMObject

Объект виртуальной машины.

Type:PSVirtualMachine
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

String

String[]

SwitchParameter

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

PSAzureOperationResponse