你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Set-AzureRmVMCustomScriptExtension
将自定义脚本扩展添加到虚拟机。
警告
截至 2024 年 2 月 29 日，AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新，建议用户从 AzureRM 迁移到 Az PowerShell 模块。
尽管 AzureRM 模块仍可能正常运行，但它不再维护或受支持，但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导，请参阅我们的迁移资源。
语法
Set-AzureRmVMCustomScriptExtension
-ContainerName <String>
-FileName <String[]>
[-StorageAccountName <String>]
[-StorageEndpointSuffix <String>]
[-StorageAccountKey <String>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzureRmVMCustomScriptExtension
[-FileUri <String[]>]
[-Run <String>]
[-Argument <String>]
[-SecureExecution]
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 说明
Set-AzureRmVMCustomScriptExtension cmdlet 将自定义脚本虚拟机扩展添加到虚拟机。 此扩展允许在虚拟机上运行自己的脚本。
示例
示例 1：添加自定义脚本
PS C:\> Set-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts"此命令将自定义脚本添加到名为 VirtualMachine07 的虚拟机。 脚本文件contososcript.exe。
参数
-Argument
指定脚本扩展传递给脚本的参数。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
| 类型: | SwitchParameter |
| 别名: | cf |
| Position: | Named |
| 默认值: | False |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ContainerName
指定此 cmdlet 存储脚本的 Azure 存储容器的名称。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
| 类型: | IAzureContextContainer |
| 别名: | AzureRmContext, AzureCredential |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-DisableAutoUpgradeMinorVersion
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-FileName
指定脚本文件的名称。 如果文件存储在 Azure Blob 存储中，则文件名值区分大小写。 存储在 Azure 文件存储中的文件的文件名不区分大小写。
| 类型: | String[] |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-FileUri
指定脚本文件的 URI。
| 类型: | String[] |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-ForceRerun
指示此 cmdlet 在虚拟机上强制重新运行相同的扩展配置，而无需卸载并重新安装该扩展。 该值可以是与当前值不同的任何字符串。 如果未更改 forceUpdateTag，则处理程序仍会应用对公共或受保护设置的更新。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-Location
指定虚拟机的位置。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-Name
指定自定义脚本扩展的名称。
| 类型: | String |
| 别名: | ExtensionName |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-ResourceGroupName
指定虚拟机资源组的名称。
| 类型: | String |
| Position: | 0 |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-Run
指定用于运行脚本的命令。
| 类型: | String |
| 别名: | RunFile, Command |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-SecureExecution
指示此 cmdlet 确保 Run 参数的值未在服务器上记录或使用 GET 扩展 API 返回给用户。 “运行”的值可能包含要安全地传递到脚本文件的机密或密码。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-StorageAccountKey
指定 Azure 存储容器的密钥。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-StorageAccountName
指定此 cmdlet 存储脚本的 Azure 存储帐户的名称。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-StorageEndpointSuffix
指定存储终结点后缀。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-TypeHandlerVersion
指定要用于此虚拟机的扩展版本。 若要获取版本，请使用 PublisherName 参数的值和 Type 参数的 VMAccessAgent 值运行 Get-AzureRmVMExtensionImage cmdlet。
| 类型: | String |
| 别名: | HandlerVersion, Version |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-VMName
指定虚拟机的名称。 此 cmdlet 为此参数指定的虚拟机添加自定义脚本扩展。
| 类型: | String |
| 别名: | ResourceName |
| Position: | 1 |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
| 类型: | SwitchParameter |
| 别名: | wi |
| Position: | Named |
| 默认值: | False |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
String[]