PoolOperations.GetRDPFile Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetRDPFile(String, String, Stream, IEnumerable<BatchClientBehavior>) |
Gets a Remote Desktop Protocol (RDP) file for the specified node. |
GetRDPFile(String, String, String, IEnumerable<BatchClientBehavior>) |
Gets a Remote Desktop Protocol file for the specified node. |
GetRDPFile(String, String, Stream, IEnumerable<BatchClientBehavior>)
- Source:
- PoolOperations.cs
Gets a Remote Desktop Protocol (RDP) file for the specified node.
public void GetRDPFile (string poolId, string computeNodeId, System.IO.Stream rdpStream, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.GetRDPFile : string * string * System.IO.Stream * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub GetRDPFile (poolId As String, computeNodeId As String, rdpStream As Stream, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)
Parameters
- poolId
- String
The id of the pool that contains the compute node.
- computeNodeId
- String
The id of the compute node for which to get a Remote Desktop file.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
Remarks
This method does not close the rdpStream
stream, and it does not reset the position after writing. It is the caller's responsibility to close the stream, or to reset the position if required.
This is a blocking operation. For a non-blocking equivalent, see GetRDPFileAsync(String, String, Stream, IEnumerable<BatchClientBehavior>, CancellationToken).
This method can be invoked only if the pool is created with a CloudServiceConfiguration property. If this method is invoked on pools created with VirtualMachineConfiguration, then Batch service returns 409 (Conflict). For pools with VirtualMachineConfiguration property, the new method GetRemoteLoginSettings(String, String, IEnumerable<BatchClientBehavior>) must be used.
Applies to
GetRDPFile(String, String, String, IEnumerable<BatchClientBehavior>)
- Source:
- PoolOperations.cs
Gets a Remote Desktop Protocol file for the specified node.
public void GetRDPFile (string poolId, string computeNodeId, string rdpFileNameToCreate, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.GetRDPFile : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub GetRDPFile (poolId As String, computeNodeId As String, rdpFileNameToCreate As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)
Parameters
- poolId
- String
The id of the pool that contains the compute node.
- computeNodeId
- String
The id of the compute node for which to get a Remote Desktop file.
- rdpFileNameToCreate
- String
The file path at which to create the RDP file.
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
Remarks
If the file specified by rdpFileNameToCreate
already exists, it is overwritten.
This is a blocking operation. For a non-blocking equivalent, see GetRDPFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken).
This method can be invoked only if the pool is created with a CloudServiceConfiguration property. If this method is invoked on pools created with VirtualMachineConfiguration, then Batch service returns 409 (Conflict). For pools with VirtualMachineConfiguration property, the new method GetRemoteLoginSettings(String, String, IEnumerable<BatchClientBehavior>) must be used.
Applies to
Azure SDK for .NET
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk