Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureBatchRDPFile

Get-AzureBatchRDPFile

microsoft.azure.commands.batch.dll

Synopsis

Downloads an RDP file pointing to the specified vm.

Syntax

Get-AzureBatchRDPFile [-VM] [-VM] [-BatchContext] [-DestinationPath] [<CommonParameters>]

Get-AzureBatchRDPFile [-VM] [-BatchContext] [-DestinationStream] [-VM] [<CommonParameters>]

Get-AzureBatchRDPFile [-PoolName] [-VM] [-VMName] [-BatchContext] [-DestinationPath] [<CommonParameters>]

Get-AzureBatchRDPFile [-VM] [-BatchContext] [-DestinationStream] [-PoolName] [-VMName] [<CommonParameters>]

Detailed Description

Downloads an RDP file pointing to the specified vm to the specified file location or to the user supplied stream.

Parameters

-BatchContext <BatchAccountContext>

The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-DestinationPath <string>

The file path where the RDP file will be downloaded.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DestinationStream <Stream>

The Stream into which the RDP file data will be written. This stream will not be closed or rewound by this call.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PoolName <string>

The name of the pool containing the vm.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VM <PSVM>

The PSVM object representing the vm to which the RDP file will point. Use the Get-AzureBatchVM cmdlet to get a PSVM object.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-VMName <string>

The name of the vm to which the RDP file will point.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

Downloads an RDP file to the vm named "tvm-1900272697_1-20150330t205553z" in the pool named "myPool". The file is downloaded to the "E:\PowerShell\vm.rdp" file path.

          Get-AzureBatchRDPFile -PoolName "myPool" -VMName "tvm-1900272697_1-20150330t205553z" -DestinationPath "E:\PowerShell\vm.rdp" -BatchContext $context
        

-------------------------- EXAMPLE 2 --------------------------

C:\PS>

Description

-----------

Downloads an RDP file to the vm named "tvm-1900272697_1-20150330t205553z" in the pool named "myPool". The file is downloaded to the "E:\PowerShell\vm.rdp" file path.

          Get-AzureBatchVM -PoolName "myPool" -Name "tvm-1900272697_1-20150330t205553z" -BatchContext $context | Get-AzureBatchRDPFile -DestinationPath "E:\PowerShell\vm.rdp" -BatchContext $context
        

-------------------------- EXAMPLE 3 --------------------------

C:\PS>

Description

-----------

Downloads an RDP file to the vm named "tvm-1900272697_1-20150330t205553z" in the pool named "myPool". The file contents are copied to the user supplied Stream.

          $stream = New-Object System.IO.MemoryStream; Get-AzureBatchRDPFile "myPool" "tvm-1900272697_1-20150330t205553z" -DestinationStream $stream -BatchContext $context