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 コマンドレットは、System Management Automation (SMA) で変数を作成または変更します。 変数の名前と値を指定します。
変数を暗号化するには、Encrypted パラメーターを使用します。 作成後に変数の暗号化された状態を変更することはできません。 暗号化されていない既存の変数で Encrypted パラメーターを使用すると、このコマンドレットは失敗します。
例
例 1: 変数に値を割り当てる
PS C:\> Set-SmaVariable -Name "Variable01" -Value "String07" -WebServiceEndpoint "https://contoso.com/app01" -Encryptedこのコマンドは、指定された Web サービス エンドポイントの Variable01 という名前の変数に値 String07 を割り当てます。 このコマンドは、Encrypted パラメーターを指定するため、変数を暗号化します。
パラメーター
-AuthenticationType
認証の種類を指定します。 有効な値は次のとおりです。
- 基本的な
- ウィンドウズ
このパラメーターの既定値は Windows です。 基本認証を使用する場合は、Credential パラメーターを使用して資格情報を指定する必要があります。
| 型: | String |
| 指定可能な値: | Basic, Windows |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Credential
SMA Web サービスへの接続 PSCredential オブジェクトを指定します。
資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細については、「Get-Help Get-Credential」と入力します。
| 型: | PSCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Description
変数の説明を提供します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Encrypted
このコマンドレットが変数を暗号化することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
確認を求めずに変数を変更します。 Value パラメーターの値として SecureString を指定すると、コマンドレットは続行する前に確認を求められます。 このコマンドレットは、値に SecureString をフィールドとして持つオブジェクトが含まれており、Encrypted パラメーターを使用しない場合にもメッセージを表示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
変数の名前を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Port
SMA Web サービスのポート番号を指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Value
変数の値を指定します。
| 型: | Object |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WebServiceEndpoint
SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |