Set-AzureRMVMDiagnosticsExtension
仮想マシンで Azure 診断 拡張機能を構成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRMVMDiagnosticsExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-DiagnosticsConfigurationPath] <String>
[[-StorageAccountName] <String>]
[[-StorageAccountKey] <String>]
[[-StorageAccountEndpoint] <String>]
[[-StorageContext] <IStorageContext>]
[[-Location] <String>]
[[-Name] <String>]
[[-TypeHandlerVersion] <String>]
[[-AutoUpgradeMinorVersion] <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Set-AzureRmVMDiagnosticsExtension コマンドレットは、仮想マシンで Azure 診断拡張機能を構成します。
例
例 1: 診断構成ファイルで指定されたストレージ アカウントを使用して診断を有効にする
PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml"
このコマンドでは、診断構成ファイルを使用して診断を有効にします。 ファイル 診断_publicconfig.xmlには、データの送信先となるストレージ アカウントの名前を含む、診断拡張機能のパブリック XML 構成診断含まれています。 診断 ストレージ アカウントは、仮想マシンと同じサブスクリプションに存在する必要があります。
例 2: ストレージ アカウント名を使用して診断を有効にする
PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount"
このコマンドでは、ストレージ アカウント名を使用して診断を有効にします。 診断構成でストレージ アカウント名が指定されていない場合、または構成ファイルで指定された診断ストレージ アカウント名をオーバーライドする場合は、StorageAccountName パラメーターを使用します。 診断 ストレージ アカウントは、仮想マシンと同じサブスクリプションに存在する必要があります。
例 3: ストレージ アカウント名とキーを使用して診断を有効にする
PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key
このコマンドでは、ストレージ アカウント名とキーを使用して診断を有効にします。 診断ストレージ アカウントが仮想マシンとは異なるサブスクリプションにある場合は、そのストレージ アカウントの名前とキーを明示的に指定して、診断データをそのストレージ アカウントに送信できるようにします。
パラメーター
-AutoUpgradeMinorVersion
このコマンドレットを使用して、Azure ゲスト エージェントが拡張機能を新しいマイナー バージョンに自動的に更新できるかどうかを示します。
型: | Boolean |
配置: | 10 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DiagnosticsConfigurationPath
構成ファイルのパスを指定します。
型: | String |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Location
仮想マシンの場所を指定します。
型: | String |
配置: | 7 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
拡張機能の名前を指定します。
型: | String |
Aliases: | ExtensionName |
配置: | 8 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StorageAccountEndpoint
ストレージ アカウント エンドポイントを指定します。
型: | String |
配置: | 5 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StorageAccountKey
ストレージ アカウント キーを指定します。
型: | String |
配置: | 4 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StorageAccountName
ストレージ アカウント名を指定します。
型: | String |
配置: | 3 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StorageContext
Azure ストレージ コンテキストを指定します。
型: | IStorageContext |
配置: | 6 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TypeHandlerVersion
この仮想マシンに使用する拡張機能のバージョンを指定します。 バージョンを取得するには、PublisherName パラメーターに Microsoft.Compute、Type パラメーターに VMAccessAgent の値を指定して Get-AzureRmVMExtensionImage コマンドレットを実行します。
型: | String |
Aliases: | HandlerVersion, Version |
配置: | 9 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-VMName
このコマンドレットが動作する仮想マシンの名前を指定します。
型: | String |
Aliases: | ResourceName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |