Get-AzCloudServiceRoleInstanceRemoteDesktopFile

Reference

Module:: Az.CloudService

Gets a remote desktop file for a role instance in a cloud service.

Syntax

Get-AzCloudServiceRoleInstanceRemoteDesktopFile
   -CloudServiceName <String>
   -ResourceGroupName <String>
   -RoleInstanceName <String>
   [-SubscriptionId <String[]>]
   -OutFile <String>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]

Description

Gets a remote desktop file for a role instance in a cloud service.

Examples

Example 1: Get an RDP file

Get-AzCloudServiceRoleInstanceRemoteDesktopFile -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" -OutFile "C:\temp\ContosoFrontEnd_IN_0.rdp"

This command gets an RDP file for the role instance named ContosoFrontEnd_IN_0 of cloud Service named ContosoCS that belongs to the resource group named ContosOrg.

Parameters

-CloudServiceName

Name of the cloud service.

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

-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

-OutFile

Path to write output file to

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

Name of the resource group.

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

-RoleInstanceName

Name of the role instance.

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

-SubscriptionId

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

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

Outputs

Boolean

Share via