你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzConnectedMachineExtension

用于创建或更新扩展的操作。

语法

Set-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   -Location <String>
   [-SubscriptionId <String>]
   [-AutoUpgradeMinorVersion]
   [-EnableAutomaticUpgrade]
   [-ExtensionType <String>]
   [-ForceRerun <String>]
   [-InstanceViewName <String>]
   [-InstanceViewType <String>]
   [-InstanceViewTypeHandlerVersion <String>]
   [-ProtectedSetting <Hashtable>]
   [-Publisher <String>]
   [-Setting <Hashtable>]
   [-StatusCode <String>]
   [-StatusDisplayStatus <String>]
   [-StatusLevel <StatusLevelTypes>]
   [-StatusMessage <String>]
   [-StatusTime <DateTime>]
   [-Tag <Hashtable>]
   [-TypeHandlerVersion <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Set-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   -ExtensionParameter <IMachineExtension>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

说明

用于创建或更新扩展的操作。

示例

示例 1:在计算机上设置扩展

$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
Set-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName win-eastus1 -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension

Name   Location ProvisioningState
----   -------- -----------------
custom eastus   Succeeded

在计算机上设置扩展。

示例 2:使用通过管道指定的扩展参数设置扩展

$otherExtension = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other
$otherExtension | Set-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName important

Name   Location ProvisioningState
----   -------- -----------------
custom eastus   Succeeded

这会设置一个扩展,其中包含通过管道传入的对象提供的扩展参数。 如果要获取一台计算机的参数并将其应用于另一台计算机,则这一点很好。

参数

-AsJob

将命令作为作业运行

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

-AutoUpgradeMinorVersion

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-EnableAutomaticUpgrade

指示是否有较新版本可用,平台是否应自动升级扩展。

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

-ExtensionParameter

描述计算机扩展。 若要构造,请参阅 EXTENSIONPARAMETER 属性的 NOTES 部分并创建哈希表。

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

-ExtensionType

指定扩展的类型;例如“CustomScriptExtension”。

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

-ForceRerun

即使扩展配置尚未更改,扩展处理程序也应强制更新。

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

-InstanceViewName

计算机扩展名称。

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

-InstanceViewType

指定扩展的类型;例如“CustomScriptExtension”。

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

-InstanceViewTypeHandlerVersion

指定脚本处理程序的版本。

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

-Location

资源所在的地理位置

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

-MachineName

应在其中创建或更新扩展的计算机的名称。

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

-Name

计算机扩展的名称。

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

-NoWait

异步运行命令

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

-ProtectedSetting

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。

Type:Hashtable
Aliases:ProtectedSettings
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Publisher

扩展处理程序发布者的名称。

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

-ResourceGroupName

资源组的名称。 此名称不区分大小写。

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

-Setting

扩展的 Json 格式公共设置。

Type:Hashtable
Aliases:Settings
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-StatusCode

状态代码。

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

-StatusDisplayStatus

状态的简短可本地化标签。

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

-StatusLevel

级别代码。

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

-StatusMessage

详细状态消息,包括警报和错误消息。

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

-StatusTime

状态的时间。

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

-SubscriptionId

目标订阅的 ID。

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

-Tag

资源标记。

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

-TypeHandlerVersion

指定脚本处理程序的版本。

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

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。

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

输入

IMachineExtension

输出

IMachineExtension

备注

别名

复杂参数属性

若要创建下面所述的参数,请构造包含相应属性的哈希表。 有关哈希表的信息,请运行Get-Help about_Hash_Tables。

EXTENSIONPARAMETER <IMachineExtension>:描述计算机扩展。

  • Location <String>:资源所在的地理位置
  • [Tag <ITrackedResourceTags>]:资源标记。
    • [(Any) <String>]:这表示可以将任何属性添加到此对象。
  • [AutoUpgradeMinorVersion <Boolean?>]:指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。
  • [EnableAutomaticUpgrade <Boolean?>]:指示是否有较新版本可用,平台是否应自动升级扩展。
  • [ForceUpdateTag <String>]:即使扩展配置未更改,扩展处理程序也应强制更新。
  • [InstanceViewName <String>]:计算机扩展名称。
  • [InstanceViewType <String>]:指定扩展的类型;例如“CustomScriptExtension”。
  • [InstanceViewTypeHandlerVersion <String>]:指定脚本处理程序的版本。
  • [MachineExtensionType <String>]:指定扩展的类型;例如“CustomScriptExtension”。
  • [ProtectedSetting <IMachineExtensionPropertiesProtectedSettings>]:扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。
    • [(Any) <Object>]:这表示可以将任何属性添加到此对象。
  • [Publisher <String>]:扩展处理程序发布者的名称。
  • [Setting <IMachineExtensionPropertiesSettings>]:扩展的 Json 格式公共设置。
    • [(Any) <Object>]:这表示可以将任何属性添加到此对象。
  • [StatusCode <String>]:状态代码。
  • [StatusDisplayStatus <String>]:状态的简短可本地化标签。
  • [StatusLevel <StatusLevelTypes?>]:级别代码。
  • [StatusMessage <String>]:详细状态消息,包括警报和错误消息。
  • [StatusTime <DateTime?>]:状态的时间。
  • [SystemDataCreatedAt <DateTime?>]:资源创建时间戳 (UTC) 。
  • [SystemDataCreatedBy <String>]:创建资源的标识。
  • [SystemDataCreatedByType <CreatedByType?>]:创建资源的标识的类型。
  • [SystemDataLastModifiedAt <DateTime?>]:资源上次修改的时间戳 (UTC)
  • [SystemDataLastModifiedBy <String>]:上次修改资源的标识。
  • [SystemDataLastModifiedByType <CreatedByType?>]:上次修改资源的标识的类型。
  • [TypeHandlerVersion <String>]:指定脚本处理程序的版本。