Set-AzVMDiagnosticsExtension
仮想マシンで Azure Diagnostics 拡張機能を構成します。
構文
Default (既定)
Set-AzVMDiagnosticsExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-DiagnosticsConfigurationPath] <String>
[[-StorageAccountName] <String>]
[[-StorageAccountKey] <String>]
[[-StorageAccountEndpoint] <String>]
[[-StorageContext] <IStorageContext>]
[[-Location] <String>]
[[-Name] <String>]
[[-TypeHandlerVersion] <String>]
[[-AutoUpgradeMinorVersion] <Boolean>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Set-AzVMDiagnosticsExtension コマンドレットは、仮想マシン上で Azure Diagnostics 拡張機能を構成します。
例
例 1: 診断構成ファイルで指定されたストレージ アカウントを使用して診断を有効にする
Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml"
このコマンドでは、診断構成ファイルを使用して診断を有効にします。
diagnostics_publicconfig.xml ファイルには、診断データの送信先となるストレージ アカウントの名前など、診断拡張機能のパブリック XML 構成が含まれています。
診断ストレージ アカウントは、仮想マシンと同じサブスクリプションに存在する必要があります。
例 2: ストレージ アカウント名を使用して診断を有効にする
Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount"
このコマンドでは、ストレージ アカウント名を使用して診断を有効にします。
診断構成でストレージ アカウント名が指定されていない場合、または構成ファイルで指定された診断ストレージ アカウント名をオーバーライドする場合は、 StorageAccountName パラメーターを使用します。
診断ストレージ アカウントは、仮想マシンと同じサブスクリプションに存在する必要があります。
例 3: ストレージ アカウント名とキーを使用して診断を有効にする
Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key
このコマンドでは、ストレージ アカウント名とキーを使用して診断を有効にします。
診断ストレージ アカウントが仮想マシンとは異なるサブスクリプションにある場合は、名前とキーを明示的に指定して、そのストレージ アカウントへの診断データの送信を有効にします。
パラメーター
-AutoUpgradeMinorVersion
このコマンドレットを使用して、Azure ゲスト エージェントが拡張機能を新しいマイナー バージョンに自動的に更新できるかどうかを示します。
パラメーターのプロパティ
| 型: | Boolean
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 10 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DiagnosticsConfigurationPath
構成ファイルのパスを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Location
仮想マシンの場所を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 7 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
拡張機能の名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | エクステンション名 |
パラメーター セット
(All)
| 配置: | 8 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-NoWait
操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-StorageAccountEndpoint
ストレージ アカウント エンドポイントを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 5 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-StorageAccountKey
ストレージ アカウント キーを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 4 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-StorageAccountName
ストレージ アカウント名を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-StorageContext
Azure ストレージ コンテキストを指定します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | 6 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TypeHandlerVersion
この仮想マシンに使用する拡張機能のバージョンを指定します。
バージョンを取得するには、 PublisherName パラメーターに Microsoft.Compute、 Type パラメーターに VMAccessAgent の値を指定して、Get-AzVMExtensionImage コマンドレットを実行します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | HandlerVersion, バージョン |
パラメーター セット
(All)
| 配置: | 9 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VMName
このコマンドレットが動作する仮想マシンの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ResourceName |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
