Set-AzVMChefExtension
構文
Linux
Set-AzVMChefExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[[-TypeHandlerVersion] <String>]
[[-Location] <String>]
[[-Name] <String>]
[[-AutoUpgradeMinorVersion] <Boolean>]
-ValidationPem <String>
[-ClientRb <String>]
[-BootstrapOptions <String>]
[-JsonAttribute <String>]
[-ChefDaemonInterval <String>]
[-Daemon <String>]
[-Secret <String>]
[-SecretFile <String>]
[-RunList <String>]
[-ChefServerUrl <String>]
[-ValidationClientName <String>]
[-OrganizationName <String>]
[-BootstrapVersion <String>]
[-Linux]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Windows
Set-AzVMChefExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[[-TypeHandlerVersion] <String>]
[[-Location] <String>]
[[-Name] <String>]
[[-AutoUpgradeMinorVersion] <Boolean>]
-ValidationPem <String>
[-ClientRb <String>]
[-BootstrapOptions <String>]
[-JsonAttribute <String>]
[-ChefDaemonInterval <String>]
[-Daemon <String>]
[-Secret <String>]
[-SecretFile <String>]
[-RunList <String>]
[-ChefServerUrl <String>]
[-ValidationClientName <String>]
[-OrganizationName <String>]
[-BootstrapVersion <String>]
[-Windows]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzVMChefExtension コマンドレットは、Chef 拡張機能を仮想マシンに追加します。
例
例 1: Windows 仮想マシンに Chef 拡張機能を追加する
Set-AzVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Daemon "service" -SecretFile "C:\my_encrypted_data_bag_secret" -Windows
このコマンドは、WindowsVM001 という名前の Windows 仮想マシンに Chef 拡張機能を追加します。
仮想マシンが起動すると、Chef によって仮想マシンがブートストラップされ、Apache が実行されます。
例 2: Linux 仮想マシンに Chef 拡張機能を追加する
Set-AzVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Secret "my_secret" -Linux
このコマンドは、LinuxVM001 という名前の Linux 仮想マシンに Chef 拡張機能を追加します。
仮想マシンが起動すると、Chef によって仮想マシンがブートストラップされ、Apache が実行されます。
例 3: ブートストラップ オプションを使用して Windows 仮想マシンに Chef 拡張機能を追加する
Set-AzVMChefExtension -ResourceGroupName "ResourceGroup003" -VMName "WindowsVM002" -ValidationPem C:\my-org-validator.pem -ClientRb C:\client.rb -BootstrapOptions '{"chef_node_name":"your_node_name","chef_server_url":"https://api.opscode.com/organizations/some-org", "validation_client_name":"some-org-validator"}' -RunList "Apache" -Windows
このコマンドは、WindowsVM002 という名前の Windows 仮想マシンに Chef 拡張機能を追加します。
仮想マシンが起動すると、Chef によって仮想マシンがブートストラップされ、Apache が実行されます。
ブートストラップ後、仮想マシンは JSON 形式で指定された BootstrapOptions を参照します。
パラメーター
-AutoUpgradeMinorVersion
Set-AzVMChefExtension コマンドレットは、Chef 拡張機能を仮想マシンに追加します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 10 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-BootstrapOptions
client_rb オプションの構成設定を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-BootstrapVersion
ブートストラップ構成のバージョンを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ChefDaemonInterval
chef-service を実行する頻度 (分単位) を指定します。 Chef サービスを Azure VM にインストールしたくない場合は、このフィールドに値 0 を設定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ChefServiceInterval |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ChefServerUrl
Chef サーバー リンクを URL として指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ClientRb
Chef client.rb の完全パスを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Daemon
chef-client サービスを自動実行用に構成します。 ノード プラットフォームは Windows である必要があります。
使用できるオプション: 'none'、'service'、'task'。
none - 現在、chef-client サービスがサービスとして構成されないようにします。
service - サービスとしてバックグラウンドで自動的に実行されるように chef-client を構成します。
task - スケジュールされたタスクとしてバックグラウンドで自動的に実行されるように chef-client を構成します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| 指定可能な値: | none, service, task |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JsonAttribute
chef-client の最初の実行に追加される JSON 文字列。 例: -JsonAttribute '{"foo" : "bar"}'
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Linux
このコマンドレットによって Windows 仮想マシンが作成されることを示します。
パラメーターのプロパティ
パラメーター セット
Linux
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Location
仮想マシンの場所を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 7 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
Chef 拡張機能の名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | エクステンション名 |
パラメーター セット
(All)
| 配置: | 8 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-NoWait
操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OrganizationName
Chef 拡張機能の組織名を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceGroupName
仮想マシンを含むリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RunList
Chef ノードの実行リストを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Secret
データ バッグ項目の値の暗号化と暗号化解除に使用される暗号化キー。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SecretFile
データ バッグ項目の値の暗号化と暗号化解除に使用される暗号化キーを含むファイルへのパス。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TypeHandlerVersion
この仮想マシンに使用する拡張機能のバージョンを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | HandlerVersion, バージョン |
パラメーター セット
(All)
| 配置: | 9 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ValidationClientName
Set-AzVMChefExtension コマンドレットは、Chef 拡張機能を仮想マシンに追加します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ValidationPem
Chef 検証コントロールの .pem ファイル パスを指定します
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VMName
仮想マシンの名前を指定します。
このコマンドレットは、このパラメーターが指定する仮想マシンの Chef 拡張機能を追加します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ResourceName |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Windows
このコマンドレットによって Windows 仮想マシンが作成されることを示します。
パラメーターのプロパティ
パラメーター セット
Windows
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力