RenderingSession.GetPropertiesAsync 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.
Queries the properties of the session (hostname, lease time, size, etc).
public:
System::Threading::Tasks::Task<Microsoft::Azure::RemoteRendering::RenderingSessionPropertiesResult ^> ^ GetPropertiesAsync();public System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.RenderingSessionPropertiesResult> GetPropertiesAsync ();member this.GetPropertiesAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.RenderingSessionPropertiesResult>Public Function GetPropertiesAsync () As Task(Of RenderingSessionPropertiesResult)Returns
Session properties or an error context. The returned task will complete in an arbitrary thread.
Remarks
Since the underlying call is a REST call, there should be sufficient delay (5-10s) between subsequent calls to avoid server throttling. In case of throttling, the function will fail and the HttpResponseCode reports code 429 ("too many requests").
* A InvalidParam error occurs if the rendering service URL was empty, because the account domain and account Id was not provided. * A SessionNotFound error occurs if the corresponding session could not be found. Please check the provided session Id. * 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.