azure.mixedreality.remoterendering package¶
-
class
azure.mixedreality.remoterendering.AssetConversion(*, id: str, settings: azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversionSettings, error: azure.mixedreality.remoterendering._generated.models._models_py3.RemoteRenderingError, status: str, created_on: datetime.datetime, **kwargs)[source]¶ The properties of the conversion.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Required. The ID of the conversion supplied when the conversion was created.
settings (AssetConversionSettings) – Required. Conversion settings describe the origin of input files and destination of output files.
error (RemoteRenderingError) – Required. The error object containing details about the conversion failure.
status (str or AssetConversionStatus) – Required. The status of the conversion. Terminal states are ‘Cancelled’, ‘Failed’, and ‘Succeeded’. Possible values include: “NotStarted”, “Running”, “Cancelled”, “Failed”, “Succeeded”.
created_on (datetime) – Required. The time when the conversion was created. Date and time in ISO 8601 format.
- Variables
output (AssetConversionOutput) – Information about the output of a successful conversion. Only present when the status of the conversion is ‘Succeeded’.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.AssetConversionInputSettings(*, storage_container_uri: str, relative_input_asset_path: str, storage_container_read_list_sas: Optional[str] = None, blob_prefix: Optional[str] = None, **kwargs)[source]¶ Conversion input settings describe the origin of conversion input.
All required parameters must be populated in order to send to Azure.
- Parameters
storage_container_uri (str) – Required. The URI of the Azure blob storage container containing the input model.
storage_container_read_list_sas (str) – An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an- account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies.
blob_prefix (str) – Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded.
relative_input_asset_path (str) – Required. The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how- tos/conversion/model-conversion for details.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.AssetConversionOutput(**kwargs)[source]¶ Information about the output of a successful conversion. Only present when the status of the conversion is ‘Succeeded’.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
asset_uri (str) – URI of the asset generated by the conversion process.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.AssetConversionOutputSettings(*, storage_container_uri: str, storage_container_write_sas: Optional[str] = None, blob_prefix: Optional[str] = None, output_asset_filename: Optional[str] = None, **kwargs)[source]¶ Conversion output settings describe the destination of conversion output.
All required parameters must be populated in order to send to Azure.
- Parameters
storage_container_uri (str) – Required. The URI of the Azure blob storage container where the result of the conversion should be written to.
storage_container_write_sas (str) – An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage- accounts for details. For security purposes this field will never be filled out in responses bodies.
blob_prefix (str) – A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root.
output_asset_filename (str) – The file name of the output asset. Must end in ‘.arrAsset’. Optional. If not provided, file name will the same name as the input asset, with ‘.arrAsset’ extension.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.AssetConversionSettings(*, input_settings: azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversionInputSettings, output_settings: azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversionOutputSettings, **kwargs)[source]¶ Conversion settings describe the origin of input files and destination of output files.
All required parameters must be populated in order to send to Azure.
- Parameters
input_settings (AssetConversionInputSettings) – Required. Conversion input settings describe the origin of conversion input.
output_settings (AssetConversionOutputSettings) – Required. Conversion output settings describe the destination of conversion output.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.AssetConversionStatus(value)[source]¶ The status of the conversion. Terminal states are ‘Cancelled’, ‘Failed’, and ‘Succeeded’.
-
CANCELLED= 'Cancelled'¶ The conversion was cancelled. This is a terminal state.
-
FAILED= 'Failed'¶ The conversion has failed. Check the ‘error’ field for more details. This is a terminal state.
-
NOT_STARTED= 'NotStarted'¶ The conversion was created but hasn’t started.
-
RUNNING= 'Running'¶ The conversion is running.
-
SUCCEEDED= 'Succeeded'¶ The conversion has succeeded. Check the ‘output’ field for output asset location. This is a terminal state.
-
-
class
azure.mixedreality.remoterendering.RemoteRenderingClient(endpoint: str, account_id: str, account_domain: str, credential: Union[TokenCredential, AccessToken], **kwargs: Any)[source]¶ A client for the Azure Remote Rendering Service.
This client offers functionality to convert assets to the format expected by the runtime, and also to manage the lifetime of remote rendering sessions.
- Parameters
endpoint (str) – The rendering service endpoint. This determines the region in which the rendering session is created and asset conversions are performed.
account_id (str) – The Azure Remote Rendering account identifier.
account_domain (str) – The Azure Remote Rendering account domain. For example, for an account created in the eastus region, this will have the form “eastus.mixedreality.azure.com”
credential (Union[TokenCredential, AzureKeyCredential, AccessToken]) – Authentication for the Azure Remote Rendering account. Can be of the form of an AzureKeyCredential, TokenCredential or an AccessToken acquired from the Mixed Reality Secure Token Service (STS).
- Keyword Arguments
api_version (str or RemoteRenderingApiVersion) – The API version of the service to use for requests. It defaults to the latest service version. Setting to an older version may result in reduced feature compatibility.
-
begin_asset_conversion(conversion_id: str, input_settings: AssetConversionInputSettings, output_settings: AssetConversionOutputSettings, **kwargs: Any) → LROPoller[AssetConversion][source]¶ Start a new asset conversion with the given options. :param str conversion_id:
An ID uniquely identifying the conversion for the remote rendering account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters.
- Parameters
input_settings (AssetConversionInputSettings) – Options for the input of the conversion.
output_settings (AssetConversionOutputSettings) – Options for the output of the conversion.
- Returns
A poller for the created asset conversion
- Return type
- Raises
-
begin_rendering_session(session_id: str, size: Union[str, RenderingSessionSize], lease_time_minutes: int, **kwargs: Any) → LROPoller[RenderingSession][source]¶ - Parameters
session_id (str) – An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters.
size (str or RenderingSessionSize) – Size of the server used for the rendering session. Remote Rendering with Standard size server has a maximum scene size of 20 million polygons. Remote Rendering with Premium size does not enforce a hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service.
lease_time_minutes (int) – The time in minutes the session will run after reaching the ‘Ready’ state.
- Returns
A poller for the created rendering session
- Return type
LROPoller[RenderingSession]
- Raises
-
get_asset_conversion(conversion_id: str, **kwargs: Any) → AssetConversion[source]¶ Retrieve the state of a previously created conversion. :param str conversion_id:
The identifier of the conversion to retrieve.
- Returns
Information about the ongoing conversion process.
- Return type
AssetConversion
- Raises
-
get_asset_conversion_poller(**kwargs: Any) → LROPoller[AssetConversion][source]¶ Returns a poller for an existing conversion by conversion id or a continuation token retrieved from a previous poller. :keyword conversion_id: The conversion id of a previously created conversion. :paramtype conversion_id: str :keyword continuation_token:
A continuation token retrieved from a poller of a conversion.
- Returns
A poller for the created asset conversion
- Return type
- Raises
-
get_rendering_session(session_id: str, **kwargs: Any) → RenderingSession[source]¶ Returns the properties of a previously generated rendering session. :param str session_id: The identifier of the rendering session. :return: Properties of the rendering session :rtype: ~azure.mixedreality.remoterendering.models.RenderingSession :raises ~azure.core.exceptions.HttpResponseError:
-
get_rendering_session_poller(**kwargs: Any) → LROPoller[RenderingSession][source]¶ Returns a poller for an existing rendering session by session id or a continuation token retrieved from a previous poller. :keyword session_id: The conversion id of a previously created conversion. :paramtype session_id: str :keyword continuation_token:
A continuation token retrieved from a poller of a session.
- Raises
-
list_asset_conversions(**kwargs) → ItemPaged[AssetConversion][source]¶ Gets conversions for the remote rendering account. :rtype: ItemPaged[AssetConversion] :raises ~azure.core.exceptions.HttpResponseError:
-
list_rendering_sessions(**kwargs) → ItemPaged[RenderingSession][source]¶ - List rendering sessions in the ‘Ready’ or ‘Starting’ state. Does not return stopped or failed rendering
sessions.
- Return type
ItemPaged[RenderingSession]
- Raises
-
stop_rendering_session(session_id: str, **kwargs: Any) → None[source]¶ - Parameters
session_id (str) – The identifier of the session to be stopped.
- Returns
None
- Return type
- Raises
-
update_rendering_session(session_id: str, **kwargs: Any) → RenderingSession[source]¶ Updates an already existing rendering session. :param str session_id: The identifier of the session to be updated. :keyword lease_time_minutes: The new lease time of the rendering session. Has to be strictly larger than
the previous lease time.
- Returns
The properties of the updated session
- Return type
RenderingSession
- Raises
-
class
azure.mixedreality.remoterendering.RemoteRenderingError(*, code: str, message: str, **kwargs)[source]¶ The error object containing details of why the request failed.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
details (list[RemoteRenderingError]) – An array of details about specific errors that led to this reported error.
target (str) – The target of the particular error (e.g., the name of the property in error).
inner_error (RemoteRenderingError) – An object containing more specific information than the current object about the error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.RenderingSession(*, id: str, size: str, status: str, **kwargs)[source]¶ The properties of a rendering session.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Required. The ID of the session supplied when the session was created.
size (str or RenderingSessionSize) – Required. The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote- rendering/reference/vm-sizes for details. Possible values include: “Standard”, “Premium”.
status (str or RenderingSessionStatus) – Required. The status of the rendering session. Terminal states are ‘Error’, ‘Expired’, and ‘Stopped’. Possible values include: “Error”, “Expired”, “Starting”, “Ready”, “Stopped”.
- Variables
arr_inspector_port (int) – The TCP port at which the Azure Remote Rendering Inspector tool is hosted.
handshake_port (int) – The TCP port used for the handshake when establishing a connection.
elapsed_time_minutes (int) – Amount of time in minutes the session is or was in the ‘Ready’ state. Time is rounded down to a full minute.
hostname (str) – The hostname under which the rendering session is reachable.
lease_time_minutes (int) – The time in minutes the session will run after reaching the ‘Ready’ state.
teraflops (float) – The computational power of the rendering session GPU measured in teraflops.
error (RemoteRenderingError) – The error object containing details about the rendering session startup failure.
created_on (datetime) – The time when the rendering session was created. Date and time in ISO 8601 format.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.mixedreality.remoterendering.RenderingSessionSize(value)[source]¶ The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm- sizes for details.
-
PREMIUM= 'Premium'¶ Premium rendering session size.
-
STANDARD= 'Standard'¶ Standard rendering session size.
-
-
class
azure.mixedreality.remoterendering.RenderingSessionStatus(value)[source]¶ The status of the rendering session. Terminal states are ‘Error’, ‘Expired’, and ‘Stopped’.
-
ERROR= 'Error'¶ The rendering session has encountered an error, and is unusable. This is a terminal state.
-
EXPIRED= 'Expired'¶ The rendering session enters the ‘Expired’ state when it has been in the ‘Ready’ state longer than its lease time. This is a terminal state.
-
READY= 'Ready'¶ The rendering session is ready for incoming connections.
-
STARTING= 'Starting'¶ The rendering session is starting, but not accepting incoming connections yet.
-
STOPPED= 'Stopped'¶ The rendering session has been stopped with the ‘Stop Session’ operation. This is a terminal state.
-