Get-AzVMExtension

  • リファレンス
モジュール:
Az.Compute

仮想マシンにインストールされている仮想マシン拡張機能のプロパティを取得します。

構文

Get-AzVMExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [[-Name] <String>]
   [-Status]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzVMExtension
   [-Status]
   [-VMObject <PSVirtualMachine>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzVMExtension
   [-Status]
   [-ResourceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzVMExtension コマンドレットは、仮想マシンにインストールされている仮想マシン拡張機能のプロパティを取得します。 プロパティを取得する拡張機能の名前を指定します。 拡張機能のインスタンス ビューのみを取得するには、Status パラメーターを指定します。

例

例 1: 拡張機能のプロパティを取得する

Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension"

ResourceGroupName       : ResourceGroup11
VMName                  : VirtualMachine22
Name                    : CustomScriptExtension
Location                : eastus
Etag                    : null
Publisher               : Microsoft.Azure.Extensions
ExtensionType           : CustomScript
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                :
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :

このコマンドは、リソース グループ ResourceGroup11 の VirtualMachine22 という名前の仮想マシン上の CustomScriptExtension という名前の拡張機能のプロパティを取得します。

例 2: 拡張機能のインスタンス ビューを取得する

Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status

ResourceGroupName       : ResourceGroup11
VMName                  : VirtualMachine22
Name                    : CustomScriptExtension
Location                : eastus
Etag                    : null
Publisher               : Microsoft.Azure.Extensions
ExtensionType           : CustomScript
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                : {Microsoft.Azure.Management.Compute.Models.InstanceViewStatus}
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :

このコマンドは、リソース グループ ResourceGroup11 の VirtualMachine22 という名前の仮想マシン上の CustomScriptExtension という名前の拡張機能のインスタンス ビューを取得します。

例 3: VM にインストールされているすべての拡張機能を取得する

Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22"

ResourceGroupName       : ResourceGroup11
VMName                  : VirtualMachine22
Name                    : CustomScriptExtension
Location                : eastus
Etag                    : null
Publisher               : Microsoft.Azure.Extensions
ExtensionType           : CustomScript
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                :
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :

例 4: VMObject パラメーターを使用して拡張機能のプロパティを取得する

$vm = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine22"
Get-AzVMExtension -VMObject $vm

ResourceGroupName       : ResourceGroup11
VMName                  : VirtualMachine22
Name                    : CustomScriptExtension
Location                : eastus
Etag                    : null
Publisher               : Microsoft.Azure.Extensions
ExtensionType           : CustomScript
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                :
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :

このコマンドは、リソース グループ ResourceGroup11 の VirtualMachine22 という名前の仮想マシンにインストールされている拡張機能の一覧を取得します。

パラメーター

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

拡張機能の名前を指定します。 このコマンドレットは、このパラメーターが指定する拡張機能のプロパティを取得します。

Type:String
Aliases:ExtensionName
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

リソース グループの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

拡張機能がオンになっている仮想マシン オブジェクトを指定するリソース ID。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Status

このコマンドレットが拡張機能のインスタンス ビューのみを取得することを示します。

Type:SwitchParameter
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

仮想マシンの名前を指定します。 このコマンドレットは、このパラメーターが指定する仮想マシンから拡張機能のプロパティを取得します。

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMObject

拡張機能がオンになっている仮想マシン オブジェクトを指定します。

Type:PSVirtualMachine
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

入力

String

SwitchParameter

出力

PSVirtualMachineExtension