Get-​Azure​Rm​VM​Access​Extension

Gets information about the VMAccess extension.

Syntax

Get-AzureRmVMAccessExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name] <String>
   [-Status]
   [<CommonParameters>]

Description

The Get-AzureRmVMAccessExtension cmdlet gets information about the Virtual Machine Access (VMAccess) Virtual Machine Extension.

Examples

Example 1: Get the VMAccess extension

PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest"

This command gets the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07.

Example 2: Get the instance view of the VMAccess extension

PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -Status

This command gets the instance view of the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07.

Required Parameters

-Name

Specifies the name of the extension that this cmdlet gets.

Type:String
Aliases:ExtensionName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group of the virtual machine.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VMName

Specifies the name of a virtual machine. This cmdlet gets information about VMAccess for the virtual machine that this parameter specifies.

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

Optional Parameters

-Status

Indicates that this cmdlet gets only the instance view of the extension.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False