Get-AzNetworkCloudConsole

Reference

Module:: Az.NetworkCloud

Get properties of the provided virtual machine console.

Syntax

Get-AzNetworkCloudConsole
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -VirtualMachineName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzNetworkCloudConsole
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -VirtualMachineName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzNetworkCloudConsole
   -InputObject <INetworkCloudIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get properties of the provided virtual machine console.

Examples

Example 1: List virtual machine's consoles

Get-AzNetworkCloudConsole -SubscriptionId subscriptionId -VirtualMachineName virtualMachineName -ResourceGroupName resourceGroupName

Location Name    SystemDataCreatedAt SystemDataCreatedBy  SystemDataCreatedByType  SystemDataLastModifiedAt  SystemDataLastModifiedBy      SystemDataLastModifiedByType AzureAsyncOperation
-------- ----    ------------------- -------------------  ------------------------ ------------------------  ----------------------------  ----------------------------
eastus   default 06/27/2023 21:32:03  <user>              User                     06/27/2023 21:32:41       <identity>                    Application

This command gets all consoles for the provided virtual machine.

Example 2: Get virtual machine's console

Get-AzNetworkCloudConsole -Name consoleName -SubscriptionId subscriptionId -ResourceGroupName resourceGroupName -VirtualMachineName virtualMachineName

Location Name    SystemDataCreatedAt SystemDataCreatedBy  SystemDataCreatedByType  SystemDataLastModifiedAt  SystemDataLastModifiedBy      SystemDataLastModifiedByType AzureAsyncOperation
-------- ----    ------------------- -------------------  ------------------------ ------------------------  ----------------------------  ----------------------------
eastus   default 06/27/2023 21:32:03  <user>              User                     06/27/2023 21:32:41       <identity>                    Application

This command gets a specific console of the provided virtual machine.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the virtual machine console.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualMachineName

The name of the virtual machine.

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

Inputs

INetworkCloudIdentity

Outputs

IConsole

Share via