RenderingSession.StopAsync Method

Definition

Stops the Azure session. It is not possible to connect to this session again.

public:
 System::Threading::Tasks::Task<Microsoft::Azure::RemoteRendering::SessionContextResult ^> ^ StopAsync();
public System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.SessionContextResult> StopAsync ();
member this.StopAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.SessionContextResult>
Public Function StopAsync () As Task(Of SessionContextResult)

Returns

An async with a result context containing success information. The returned task will complete in an arbitrary thread.

Remarks

* A InvalidParam error occurs if the rendering service URL was empty, because the account domain and account Id was not provided. * A AuthenticationFailed error occurs if the request could not be authenticated. * A NotInitialized error occurs if the RemoteRenderingClient was not initialized. * A TooManyRequests error occurs if the rate limit has been exceeded. Retry the request after the duration given in the Retry-After header. * A DomainUnreachable error occurs if remote rendering domain is unreachable. Url may be invalid or Azure Remote Rendering is not supported in this region. * A ConnectionRefused error occurs if remote rendering connection is refused by destination host. * A ConnectionFailed error occurs if remote rendering connection failed. Exact reason is unknown. * A Timeout error occurs if remote rendering connection timed out.

Applies to