Set-SmaVariable

在 SMA 中创建或修改变量。

语法

Set-SmaVariable
   -Name <String>
   -Value <Object>
   [-Description <String>]
   [-Encrypted]
   [-Force]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-SmaVariable cmdlet 在系统管理自动化(SMA)中创建或修改变量。 指定变量的名称和值。

若要加密变量,请使用 Encrypted 参数。 创建后无法修改变量的加密状态。 如果在现有非加密变量上使用 Encrypted 参数,则此 cmdlet 将失败。

示例

示例 1:向变量赋值

PS C:\> Set-SmaVariable -Name "Variable01" -Value "String07" -WebServiceEndpoint "https://contoso.com/app01" -Encrypted

此命令将值 String07 分配给名为 Variable01 的变量的指定 Web 服务终结点。 由于该命令指定 Encrypted 参数,因此它会加密变量。

参数

-AuthenticationType

指定身份验证类型。 有效值为:

  • 基本
  • 窗户

此参数的默认值为 Windows。 如果使用基本身份验证,则必须使用 Credential 参数提供凭据。

类型:String
接受的值:Basic, Windows
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

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

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Credential

为连接到 SMA Web 服务指定 PSCredential 对象。 若要获取凭据对象,请使用 Get-Credential cmdlet。 有关详细信息,请键入 Get-Help Get-Credential

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Description

提供变量的说明。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Encrypted

指示此 cmdlet 对变量进行加密。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

在不提示确认的情况下修改变量。 如果提供 SecureString 作为 Value 参数的值,则 cmdlet 会提示你进行确认。 如果值包含 SecureString 作为字段的对象,并且不使用 Encrypted 参数,则此 cmdlet 还会提示你。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Name

指定变量的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Port

指定 SMA Web 服务的端口号。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Value

指定变量的值。

类型:Object
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WebServiceEndpoint

将终结点指定为 SMA Web 服务的 URL。 必须包括协议,例如 http:// 或 https://。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False