diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/CHANGELOG.md b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/CHANGELOG.md index 10dc75438257..520d711f515d 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/CHANGELOG.md +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/CHANGELOG.md @@ -1,7 +1,10 @@ # Release History -## 1.0.0-beta.2 (Unreleased) +## 1.0.0-beta.3 (Unreleased) +## 1.0.0-beta.2 (2021-02-11) +- Reflect minor REST API improvements. +- Make more classes mockable. ## 1.0.0-beta.1 (2021-02-10) - Initial version of client. diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/AssetConversionOperation.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/AssetConversionOperation.cs index c3d50e9abd5f..79bf31a6efdf 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/AssetConversionOperation.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/AssetConversionOperation.cs @@ -108,5 +108,10 @@ public async override ValueTask> WaitForCompletionAsyn } return _response; } + + /// Initializes a new instance of AssetConversionOperation for mocking. + protected AssetConversionOperation() + { + } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Customizations/Models/RemoteRenderingModelFactory.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Customizations/Models/RemoteRenderingModelFactory.cs new file mode 100644 index 000000000000..0c01a8bd1785 --- /dev/null +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Customizations/Models/RemoteRenderingModelFactory.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Text; + +namespace Azure.MixedReality.RemoteRendering +{ + /// + /// Model factory that enables mocking for the Remote Rendering library. + /// + public static class RemoteRenderingModelFactory + { + /// + /// Initializes a new instance of the class for mocking purposes. + /// + public static AssetConversionOutput AssetConversionOutput(Uri outputAssetUri) + => new AssetConversionOutput(outputAssetUri.ToString()); + + /// + /// Initializes a new instance of the class for mocking purposes. + /// + public static RemoteRenderingServiceError RemoteRenderingServiceError(string code, string message, IReadOnlyList details, string target, RemoteRenderingServiceError innerError) + => new RemoteRenderingServiceError(code, message, details, target, innerError); + + /// + /// Initializes a new instance of the class for mocking purposes. + /// + public static AssetConversion AssetConversion(string conversionId, AssetConversionOptions options, AssetConversionOutput output, RemoteRenderingServiceError error, AssetConversionStatus status, DateTimeOffset createdOn) + => new AssetConversion(conversionId, options, output, error, status, createdOn); + + /// + /// Initializes a new instance of the class for mocking purposes. + /// + public static RenderingSession RenderingSession(string sessionId, int? arrInspectorPort, int? handshakePort, int? elapsedTimeMinutes, string host, int? maxLeaseTimeMinutes, RenderingServerSize size, RenderingSessionStatus status, float? teraflops, RemoteRenderingServiceError error, DateTimeOffset? createdOn) + => new RenderingSession(sessionId, arrInspectorPort, handshakePort, elapsedTimeMinutes, host, maxLeaseTimeMinutes, size, status, teraflops, error, createdOn); + } +} diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversion.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversion.cs index 750bb68c3233..5071e6e9d5aa 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversion.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversion.cs @@ -9,14 +9,14 @@ namespace Azure.MixedReality.RemoteRendering { - /// The Conversion. + /// The properties of the conversion. public partial class AssetConversion { /// Initializes a new instance of AssetConversion. - /// The id of the conversion supplied when the conversion was created. - /// Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion. + /// The ID of the conversion supplied when the conversion was created. + /// Conversion settings describe the origin of input files and destination of output files. /// The error object containing details about the conversion failure. - /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'. + /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. /// The time when the conversion was created. Date and time in ISO 8601 format. /// or is null. internal AssetConversion(string conversionId, AssetConversionOptions options, RemoteRenderingServiceError error, AssetConversionStatus status, DateTimeOffset createdOn) @@ -38,11 +38,11 @@ internal AssetConversion(string conversionId, AssetConversionOptions options, Re } /// Initializes a new instance of AssetConversion. - /// The id of the conversion supplied when the conversion was created. - /// Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion. + /// The ID of the conversion supplied when the conversion was created. + /// Conversion settings describe the origin of input files and destination of output files. /// Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'. /// The error object containing details about the conversion failure. - /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'. + /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. /// The time when the conversion was created. Date and time in ISO 8601 format. internal AssetConversion(string conversionId, AssetConversionOptions options, AssetConversionOutput output, RemoteRenderingServiceError error, AssetConversionStatus status, DateTimeOffset createdOn) { @@ -57,7 +57,7 @@ internal AssetConversion(string conversionId, AssetConversionOptions options, As public AssetConversionOutput Output { get; } /// The error object containing details about the conversion failure. public RemoteRenderingServiceError Error { get; } - /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'. + /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. public AssetConversionStatus Status { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionInputOptions.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionInputOptions.cs index cbf0d8356dcc..9ab2b5dc63c6 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionInputOptions.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionInputOptions.cs @@ -9,12 +9,12 @@ namespace Azure.MixedReality.RemoteRendering { - /// Settings for the conversion input. + /// Conversion input settings describe the origin of conversion input. public partial class AssetConversionInputOptions { /// Initializes a new instance of AssetConversionInputOptions. /// The URI of the Azure blob storage container containing the input model. - /// The relative path starting at blobPrefix (or at the container root if blobPrefix is not specified) to the input model. Must point to file with a supported file format ending. + /// 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. /// or is null. public AssetConversionInputOptions(Uri storageContainerUri, string relativeInputAssetPath) { @@ -33,9 +33,9 @@ public AssetConversionInputOptions(Uri storageContainerUri, string relativeInput /// Initializes a new instance of AssetConversionInputOptions. /// The URI of the Azure blob storage container containing the input model. - /// An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies. - /// Only Blobs starting with this prefix will be downloaded to perform the conversion. - /// The relative path starting at blobPrefix (or at the container root if blobPrefix is not specified) to the input model. Must point to file with a supported file format ending. + /// 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. + /// 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. + /// 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. internal AssetConversionInputOptions(Uri storageContainerUri, string storageContainerReadListSas, string blobPrefix, string relativeInputAssetPath) { StorageContainerUri = storageContainerUri; @@ -43,9 +43,9 @@ internal AssetConversionInputOptions(Uri storageContainerUri, string storageCont BlobPrefix = blobPrefix; RelativeInputAssetPath = relativeInputAssetPath; } - /// An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies. + /// 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. public string StorageContainerReadListSas { get; set; } - /// Only Blobs starting with this prefix will be downloaded to perform the conversion. + /// 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. public string BlobPrefix { get; set; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOptions.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOptions.cs index 9230fe1ce5ff..38de9c55f094 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOptions.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOptions.cs @@ -9,12 +9,12 @@ namespace Azure.MixedReality.RemoteRendering { - /// Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion. + /// Conversion settings describe the origin of input files and destination of output files. public partial class AssetConversionOptions { /// Initializes a new instance of AssetConversionOptions. - /// Settings for the conversion input. - /// Settings for the conversion output. + /// Conversion input settings describe the origin of conversion input. + /// Conversion output settings describe the destination of conversion output. /// or is null. public AssetConversionOptions(AssetConversionInputOptions inputOptions, AssetConversionOutputOptions outputOptions) { diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutput.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutput.cs index 3938dd3da78e..f678476ff738 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutput.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutput.cs @@ -16,13 +16,13 @@ internal AssetConversionOutput() } /// Initializes a new instance of AssetConversionOutput. - /// URL of the asset generated by the conversion process. + /// URI of the asset generated by the conversion process. internal AssetConversionOutput(string outputAssetUri) { OutputAssetUri = outputAssetUri; } - /// URL of the asset generated by the conversion process. + /// URI of the asset generated by the conversion process. public string OutputAssetUri { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutputOptions.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutputOptions.cs index 68dc359cb77c..f356611ba4ec 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutputOptions.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionOutputOptions.cs @@ -9,7 +9,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// Settings for the conversion output. + /// Conversion output settings describe the destination of conversion output. public partial class AssetConversionOutputOptions { /// Initializes a new instance of AssetConversionOutputOptions. @@ -27,9 +27,9 @@ public AssetConversionOutputOptions(Uri storageContainerUri) /// Initializes a new instance of AssetConversionOutputOptions. /// The URI of the Azure blob storage container where the result of the conversion should be written to. - /// An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies. - /// A prefix which gets prepended in front of all files produced by the conversion process. Will be treaded as a virtual folder. - /// The file name of the output asset. Must end in '.arrAsset'. + /// 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. + /// 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. + /// 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. internal AssetConversionOutputOptions(Uri storageContainerUri, string storageContainerWriteSas, string blobPrefix, string outputAssetFilename) { StorageContainerUri = storageContainerUri; @@ -37,11 +37,11 @@ internal AssetConversionOutputOptions(Uri storageContainerUri, string storageCon BlobPrefix = blobPrefix; OutputAssetFilename = outputAssetFilename; } - /// An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies. + /// 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. public string StorageContainerWriteSas { get; set; } - /// A prefix which gets prepended in front of all files produced by the conversion process. Will be treaded as a virtual folder. + /// 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. public string BlobPrefix { get; set; } - /// The file name of the output asset. Must end in '.arrAsset'. + /// 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. public string OutputAssetFilename { get; set; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionStatus.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionStatus.cs index e506216fd645..8f7779c3a930 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionStatus.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/AssetConversionStatus.cs @@ -10,7 +10,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'. + /// The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. public readonly partial struct AssetConversionStatus : IEquatable { private readonly string _value; @@ -28,15 +28,15 @@ public AssetConversionStatus(string value) private const string FailedValue = "Failed"; private const string SucceededValue = "Succeeded"; - /// NotStarted. + /// The conversion was created but hasn't started. public static AssetConversionStatus NotStarted { get; } = new AssetConversionStatus(NotStartedValue); - /// Running. + /// The conversion is running. public static AssetConversionStatus Running { get; } = new AssetConversionStatus(RunningValue); - /// Cancelled. + /// The conversion was cancelled. This is a terminal state. public static AssetConversionStatus Cancelled { get; } = new AssetConversionStatus(CancelledValue); - /// Failed. + /// The conversion has failed. Check the 'error' field for more details. This is a terminal state. public static AssetConversionStatus Failed { get; } = new AssetConversionStatus(FailedValue); - /// Succeeded. + /// The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state. public static AssetConversionStatus Succeeded { get; } = new AssetConversionStatus(SucceededValue); /// Determines if two values are the same. public static bool operator ==(AssetConversionStatus left, AssetConversionStatus right) => left.Equals(right); diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ConversionList.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ConversionList.cs index bfc172d84392..6c84a48e02af 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ConversionList.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ConversionList.cs @@ -11,7 +11,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// The ConversionList. + /// List of conversions. internal partial class ConversionList { /// Initializes a new instance of ConversionList. @@ -29,7 +29,7 @@ internal ConversionList(IEnumerable conversions) /// Initializes a new instance of ConversionList. /// The list of conversions. - /// If more conversions are available this link with the same authentication header can be used to retrieve further values. + /// If more conversions are available this field will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. internal ConversionList(IReadOnlyList conversions, string nextLink) { Conversions = conversions; @@ -38,7 +38,7 @@ internal ConversionList(IReadOnlyList conversions, string nextL /// The list of conversions. public IReadOnlyList Conversions { get; } - /// If more conversions are available this link with the same authentication header can be used to retrieve further values. + /// If more conversions are available this field will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. public string NextLink { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/CreateConversionSettings.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/CreateConversionSettings.cs index 5e0cfda2c70e..9b4290113f54 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/CreateConversionSettings.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/CreateConversionSettings.cs @@ -13,7 +13,7 @@ namespace Azure.MixedReality.RemoteRendering internal partial class CreateConversionSettings { /// Initializes a new instance of CreateConversionSettings. - /// Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion. + /// Conversion settings describe the origin of input files and destination of output files. /// is null. public CreateConversionSettings(AssetConversionOptions settings) { @@ -25,7 +25,7 @@ public CreateConversionSettings(AssetConversionOptions settings) Settings = settings; } - /// Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion. + /// Conversion settings describe the origin of input files and destination of output files. public AssetConversionOptions Settings { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ErrorResponse.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ErrorResponse.cs index 8cb88a78179e..6d710b1198f4 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ErrorResponse.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/ErrorResponse.cs @@ -10,7 +10,7 @@ namespace Azure.MixedReality.RemoteRendering.Models { - /// The ErrorResponse. + /// The error response containing details of why the request failed. internal partial class ErrorResponse { /// Initializes a new instance of ErrorResponse. diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RemoteRenderingServiceError.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RemoteRenderingServiceError.cs index 78156f00ef9a..a443f9b7faed 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RemoteRenderingServiceError.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RemoteRenderingServiceError.cs @@ -11,7 +11,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// The Error. + /// The error object containing details of why the request failed. public partial class RemoteRenderingServiceError { /// Initializes a new instance of RemoteRenderingServiceError. diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingServerSize.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingServerSize.cs index 9371a6ac86cf..a33ab009f8cb 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingServerSize.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingServerSize.cs @@ -10,7 +10,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// 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. + /// 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. public readonly partial struct RenderingServerSize : IEquatable { private readonly string _value; @@ -25,9 +25,9 @@ public RenderingServerSize(string value) private const string StandardValue = "Standard"; private const string PremiumValue = "Premium"; - /// Standard. + /// Standard rendering session size. public static RenderingServerSize Standard { get; } = new RenderingServerSize(StandardValue); - /// Premium. + /// Premium rendering session size. public static RenderingServerSize Premium { get; } = new RenderingServerSize(PremiumValue); /// Determines if two values are the same. public static bool operator ==(RenderingServerSize left, RenderingServerSize right) => left.Equals(right); diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSession.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSession.cs index 8f197f13ac0f..e4f4cdde136d 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSession.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSession.cs @@ -9,13 +9,13 @@ namespace Azure.MixedReality.RemoteRendering { - /// The SessionProperties. + /// The properties of a rendering session. public partial class RenderingSession { /// Initializes a new instance of RenderingSession. - /// The id of the session supplied when the sessions was created. - /// 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. - /// The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'. + /// The ID of the session supplied when the session was created. + /// 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. + /// The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. /// is null. internal RenderingSession(string sessionId, RenderingServerSize size, RenderingSessionStatus status) { @@ -30,15 +30,15 @@ internal RenderingSession(string sessionId, RenderingServerSize size, RenderingS } /// Initializes a new instance of RenderingSession. - /// The id of the session supplied when the sessions was created. + /// The ID of the session supplied when the session was created. /// The TCP port at which the Azure Remote Rendering Inspector tool is hosted. - /// The TCP port used for the handshake. - /// Amount of time in minutes the session is or has been in Ready state. Time is rounded down to a full minute. + /// The TCP port used for the handshake when establishing a connection. + /// Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. /// The hostname under which the rendering session is reachable. /// The time in minutes the session will run after reaching the 'Ready' state. - /// 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. - /// The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'. - /// The computational power of the rendering session GPU measured in Teraflops. + /// 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. + /// The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. + /// The computational power of the rendering session GPU measured in teraflops. /// The error object containing details about the rendering session startup failure. /// The time when the rendering session was created. Date and time in ISO 8601 format. internal RenderingSession(string sessionId, int? arrInspectorPort, int? handshakePort, int? elapsedTimeMinutes, string host, int? maxLeaseTimeMinutes, RenderingServerSize size, RenderingSessionStatus status, float? teraflops, RemoteRenderingServiceError error, DateTimeOffset? createdOn) @@ -57,15 +57,15 @@ internal RenderingSession(string sessionId, int? arrInspectorPort, int? handshak } /// The TCP port at which the Azure Remote Rendering Inspector tool is hosted. public int? ArrInspectorPort { get; } - /// The TCP port used for the handshake. + /// The TCP port used for the handshake when establishing a connection. public int? HandshakePort { get; } - /// Amount of time in minutes the session is or has been in Ready state. Time is rounded down to a full minute. + /// Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. public int? ElapsedTimeMinutes { get; } - /// 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. + /// 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. public RenderingServerSize Size { get; } - /// The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'. + /// The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. public RenderingSessionStatus Status { get; } - /// The computational power of the rendering session GPU measured in Teraflops. + /// The computational power of the rendering session GPU measured in teraflops. public float? Teraflops { get; } /// The error object containing details about the rendering session startup failure. public RemoteRenderingServiceError Error { get; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionOptions.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionOptions.cs index 358614b57b90..41dad9cd76b4 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionOptions.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionOptions.cs @@ -7,10 +7,10 @@ namespace Azure.MixedReality.RemoteRendering { - /// The CreateSessionSettings. + /// Settings of the session to be created. public partial class RenderingSessionOptions { - /// 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. + /// 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. public RenderingServerSize Size { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionStatus.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionStatus.cs index 982a9d055ad8..bf0dc1f878f3 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionStatus.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/RenderingSessionStatus.cs @@ -10,7 +10,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'. + /// The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. public readonly partial struct RenderingSessionStatus : IEquatable { private readonly string _value; @@ -28,15 +28,15 @@ public RenderingSessionStatus(string value) private const string ReadyValue = "Ready"; private const string StoppedValue = "Stopped"; - /// Error. + /// The rendering session has encountered an error, and is unusable. This is a terminal state. public static RenderingSessionStatus Error { get; } = new RenderingSessionStatus(ErrorValue); - /// 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. public static RenderingSessionStatus Expired { get; } = new RenderingSessionStatus(ExpiredValue); - /// Starting. + /// The rendering session is starting, but not accepting incoming connections yet. public static RenderingSessionStatus Starting { get; } = new RenderingSessionStatus(StartingValue); - /// Ready. + /// The rendering session is ready for incoming connections. public static RenderingSessionStatus Ready { get; } = new RenderingSessionStatus(ReadyValue); - /// Stopped. + /// The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. public static RenderingSessionStatus Stopped { get; } = new RenderingSessionStatus(StoppedValue); /// Determines if two values are the same. public static bool operator ==(RenderingSessionStatus left, RenderingSessionStatus right) => left.Equals(right); diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/SessionsList.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/SessionsList.cs index 58c98adcebd3..108d1ce895c1 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/SessionsList.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/SessionsList.cs @@ -29,7 +29,7 @@ internal SessionsList(IEnumerable sessions) /// Initializes a new instance of SessionsList. /// The list of rendering sessions. Does not include sessions in 'Stopped' state. - /// If more rendering sessions are available this link with the same authentication header can be used to retrieve further values. + /// If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. internal SessionsList(IReadOnlyList sessions, string nextLink) { Sessions = sessions; @@ -38,7 +38,7 @@ internal SessionsList(IReadOnlyList sessions, string nextLink) /// The list of rendering sessions. Does not include sessions in 'Stopped' state. public IReadOnlyList Sessions { get; } - /// If more rendering sessions are available this link with the same authentication header can be used to retrieve further values. + /// If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. public string NextLink { get; } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/UpdateSessionOptions.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/UpdateSessionOptions.cs index 7b8cfe89d3cb..2e1ab97a3536 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/UpdateSessionOptions.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/Models/UpdateSessionOptions.cs @@ -7,7 +7,7 @@ namespace Azure.MixedReality.RemoteRendering { - /// The UpdateSessionSettings. + /// Settings used to update the session. public partial class UpdateSessionOptions { } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingStopSessionHeaders.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateConversionHeaders.cs similarity index 77% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingStopSessionHeaders.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateConversionHeaders.cs index a29633d9b96f..52840782d4b8 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingStopSessionHeaders.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateConversionHeaders.cs @@ -10,10 +10,10 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingStopSessionHeaders + internal partial class RemoteRenderingCreateConversionHeaders { private readonly Response _response; - public MixedRealityRemoteRenderingStopSessionHeaders(Response response) + public RemoteRenderingCreateConversionHeaders(Response response) { _response = response; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateSessionHeaders.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateSessionHeaders.cs similarity index 77% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateSessionHeaders.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateSessionHeaders.cs index 87c3578beb29..8256ee0b00d3 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateSessionHeaders.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingCreateSessionHeaders.cs @@ -10,10 +10,10 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingCreateSessionHeaders + internal partial class RemoteRenderingCreateSessionHeaders { private readonly Response _response; - public MixedRealityRemoteRenderingCreateSessionHeaders(Response response) + public RemoteRenderingCreateSessionHeaders(Response response) { _response = response; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingGetConversionHeaders.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingGetConversionHeaders.cs similarity index 82% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingGetConversionHeaders.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingGetConversionHeaders.cs index 2c10a1f15e1c..bdea7116f5ff 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingGetConversionHeaders.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingGetConversionHeaders.cs @@ -10,10 +10,10 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingGetConversionHeaders + internal partial class RemoteRenderingGetConversionHeaders { private readonly Response _response; - public MixedRealityRemoteRenderingGetConversionHeaders(Response response) + public RemoteRenderingGetConversionHeaders(Response response) { _response = response; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingListConversionsHeaders.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingListConversionsHeaders.cs similarity index 76% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingListConversionsHeaders.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingListConversionsHeaders.cs index 4c6cd2137171..302168af7f3f 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingListConversionsHeaders.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingListConversionsHeaders.cs @@ -10,10 +10,10 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingListConversionsHeaders + internal partial class RemoteRenderingListConversionsHeaders { private readonly Response _response; - public MixedRealityRemoteRenderingListConversionsHeaders(Response response) + public RemoteRenderingListConversionsHeaders(Response response) { _response = response; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingRestClient.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingRestClient.cs similarity index 79% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingRestClient.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingRestClient.cs index e6ad5007c3ee..21e793e5d375 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingRestClient.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingRestClient.cs @@ -15,20 +15,20 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingRestClient + internal partial class RemoteRenderingRestClient { private string endpoint; private string apiVersion; private ClientDiagnostics _clientDiagnostics; private HttpPipeline _pipeline; - /// Initializes a new instance of MixedRealityRemoteRenderingRestClient. + /// Initializes a new instance of RemoteRenderingRestClient. /// The handler for diagnostic messaging in the client. /// The HTTP pipeline for sending and receiving REST requests and responses. - /// The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com a list can be found at https://docs.microsoft.com/en-us/azure/remote-rendering/reference/regions. + /// The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions. /// Api Version. /// or is null. - public MixedRealityRemoteRenderingRestClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, string endpoint, string apiVersion = "2021-01-01-preview") + public RemoteRenderingRestClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, string endpoint, string apiVersion = "2021-01-01-preview") { if (endpoint == null) { @@ -66,20 +66,13 @@ internal HttpMessage CreateCreateConversionRequest(Guid accountId, string conver return message; } - /// - /// Creates a conversion using an asset stored in an Azure Blob Storage account. - /// If the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided. - /// Documentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the [documentation](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts). - /// - /// All files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix. - /// . - /// - /// the Azure Remote Rendering account id. + /// Creates a conversion using an asset stored in an Azure Blob Storage account. + /// The Azure Remote Rendering account ID. /// An ID uniquely identifying the conversion 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. /// Request body configuring the settings for an asset conversion. /// The cancellation token to use. /// or is null. - public async Task> CreateConversionAsync(Guid accountId, string conversionId, CreateConversionSettings body, CancellationToken cancellationToken = default) + public async Task> CreateConversionAsync(Guid accountId, string conversionId, CreateConversionSettings body, CancellationToken cancellationToken = default) { if (conversionId == null) { @@ -92,7 +85,7 @@ public async Task - /// Creates a conversion using an asset stored in an Azure Blob Storage account. - /// If the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided. - /// Documentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the [documentation](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts). - /// - /// All files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix. - /// . - /// - /// the Azure Remote Rendering account id. + /// Creates a conversion using an asset stored in an Azure Blob Storage account. + /// The Azure Remote Rendering account ID. /// An ID uniquely identifying the conversion 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. /// Request body configuring the settings for an asset conversion. /// The cancellation token to use. /// or is null. - public ResponseWithHeaders CreateConversion(Guid accountId, string conversionId, CreateConversionSettings body, CancellationToken cancellationToken = default) + public ResponseWithHeaders CreateConversion(Guid accountId, string conversionId, CreateConversionSettings body, CancellationToken cancellationToken = default) { if (conversionId == null) { @@ -134,7 +120,7 @@ public ResponseWithHeaders Gets the status of a previously created asset conversion. - /// the Azure Remote Rendering account id. + /// Gets the status of a particular conversion. + /// The Azure Remote Rendering account ID. /// An ID uniquely identifying the conversion 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. /// The cancellation token to use. /// is null. - public async Task> GetConversionAsync(Guid accountId, string conversionId, CancellationToken cancellationToken = default) + public async Task> GetConversionAsync(Guid accountId, string conversionId, CancellationToken cancellationToken = default) { if (conversionId == null) { @@ -181,7 +167,7 @@ public async Task Gets the status of a previously created asset conversion. - /// the Azure Remote Rendering account id. + /// Gets the status of a particular conversion. + /// The Azure Remote Rendering account ID. /// An ID uniquely identifying the conversion 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. /// The cancellation token to use. /// is null. - public ResponseWithHeaders GetConversion(Guid accountId, string conversionId, CancellationToken cancellationToken = default) + public ResponseWithHeaders GetConversion(Guid accountId, string conversionId, CancellationToken cancellationToken = default) { if (conversionId == null) { @@ -210,7 +196,7 @@ public ResponseWithHeaders Gets a list of all conversions. Returns a batch of conversions- if more conversions are available the @nextLink property contains the a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. - /// the Azure Remote Rendering account id. + /// Gets a list of all conversions. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. - public async Task> ListConversionsAsync(Guid accountId, CancellationToken cancellationToken = default) + public async Task> ListConversionsAsync(Guid accountId, CancellationToken cancellationToken = default) { using var message = CreateListConversionsRequest(accountId); await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); - var headers = new MixedRealityRemoteRenderingListConversionsHeaders(message.Response); + var headers = new RemoteRenderingListConversionsHeaders(message.Response); switch (message.Response.Status) { case 200: @@ -263,14 +249,14 @@ public async Task Gets a list of all conversions. Returns a batch of conversions- if more conversions are available the @nextLink property contains the a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. - /// the Azure Remote Rendering account id. + /// Gets a list of all conversions. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. - public ResponseWithHeaders ListConversions(Guid accountId, CancellationToken cancellationToken = default) + public ResponseWithHeaders ListConversions(Guid accountId, CancellationToken cancellationToken = default) { using var message = CreateListConversionsRequest(accountId); _pipeline.Send(message, cancellationToken); - var headers = new MixedRealityRemoteRenderingListConversionsHeaders(message.Response); + var headers = new RemoteRenderingListConversionsHeaders(message.Response); switch (message.Response.Status) { case 200: @@ -307,12 +293,12 @@ internal HttpMessage CreateCreateSessionRequest(Guid accountId, string sessionId } /// Creates a new rendering session. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// 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. /// Settings of the session to be created. /// The cancellation token to use. /// or is null. - public async Task> CreateSessionAsync(Guid accountId, string sessionId, RenderingSessionOptions body, CancellationToken cancellationToken = default) + public async Task> CreateSessionAsync(Guid accountId, string sessionId, RenderingSessionOptions body, CancellationToken cancellationToken = default) { if (sessionId == null) { @@ -325,7 +311,7 @@ public async Task Creates a new rendering session. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// 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. /// Settings of the session to be created. /// The cancellation token to use. /// or is null. - public ResponseWithHeaders CreateSession(Guid accountId, string sessionId, RenderingSessionOptions body, CancellationToken cancellationToken = default) + public ResponseWithHeaders CreateSession(Guid accountId, string sessionId, RenderingSessionOptions body, CancellationToken cancellationToken = default) { if (sessionId == null) { @@ -360,7 +346,7 @@ public ResponseWithHeaders Gets properties of a particular rendering session. - /// the Azure Remote Rendering account id. + /// Gets the properties of a particular rendering session. + /// The Azure Remote Rendering account ID. /// 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. /// The cancellation token to use. /// is null. @@ -421,8 +407,8 @@ public async Task> GetSessionAsync(Guid accountId, st } } - /// Gets properties of a particular rendering session. - /// the Azure Remote Rendering account id. + /// Gets the properties of a particular rendering session. + /// The Azure Remote Rendering account ID. /// 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. /// The cancellation token to use. /// is null. @@ -470,10 +456,10 @@ internal HttpMessage CreateUpdateSessionRequest(Guid accountId, string sessionId return message; } - /// Updates a particular rendering session. - /// the Azure Remote Rendering account id. + /// Updates the max lease time of a particular rendering session. + /// The Azure Remote Rendering account ID. /// 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. - /// Settings of the session to be updated. + /// Settings used to update the session. /// The cancellation token to use. /// or is null. public async Task> UpdateSessionAsync(Guid accountId, string sessionId, UpdateSessionOptions body, CancellationToken cancellationToken = default) @@ -503,10 +489,10 @@ public async Task> UpdateSessionAsync(Guid accountId, } } - /// Updates a particular rendering session. - /// the Azure Remote Rendering account id. + /// Updates the max lease time of a particular rendering session. + /// The Azure Remote Rendering account ID. /// 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. - /// Settings of the session to be updated. + /// Settings used to update the session. /// The cancellation token to use. /// or is null. public Response UpdateSession(Guid accountId, string sessionId, UpdateSessionOptions body, CancellationToken cancellationToken = default) @@ -555,11 +541,11 @@ internal HttpMessage CreateStopSessionRequest(Guid accountId, string sessionId) } /// Stops a particular rendering session. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// 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. /// The cancellation token to use. /// is null. - public async Task> StopSessionAsync(Guid accountId, string sessionId, CancellationToken cancellationToken = default) + public async Task> StopSessionAsync(Guid accountId, string sessionId, CancellationToken cancellationToken = default) { if (sessionId == null) { @@ -568,7 +554,7 @@ public async Task Stops a particular rendering session. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// 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. /// The cancellation token to use. /// is null. - public ResponseWithHeaders StopSession(Guid accountId, string sessionId, CancellationToken cancellationToken = default) + public ResponseWithHeaders StopSession(Guid accountId, string sessionId, CancellationToken cancellationToken = default) { if (sessionId == null) { @@ -592,7 +578,7 @@ public ResponseWithHeaders StopSe using var message = CreateStopSessionRequest(accountId, sessionId); _pipeline.Send(message, cancellationToken); - var headers = new MixedRealityRemoteRenderingStopSessionHeaders(message.Response); + var headers = new RemoteRenderingStopSessionHeaders(message.Response); switch (message.Response.Status) { case 204: @@ -618,8 +604,8 @@ internal HttpMessage CreateListSessionsRequest(Guid accountId) return message; } - /// Get a list of all rendering sessions. - /// the Azure Remote Rendering account id. + /// Gets a list of all rendering sessions. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. public async Task> ListSessionsAsync(Guid accountId, CancellationToken cancellationToken = default) { @@ -639,8 +625,8 @@ public async Task> ListSessionsAsync(Guid accountId, Canc } } - /// Get a list of all rendering sessions. - /// the Azure Remote Rendering account id. + /// Gets a list of all rendering sessions. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. public Response ListSessions(Guid accountId, CancellationToken cancellationToken = default) { @@ -673,12 +659,12 @@ internal HttpMessage CreateListConversionsNextPageRequest(string nextLink, Guid return message; } - /// Gets a list of all conversions. Returns a batch of conversions- if more conversions are available the @nextLink property contains the a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. + /// Gets a list of all conversions. /// The URL to the next page of results. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. /// is null. - public async Task> ListConversionsNextPageAsync(string nextLink, Guid accountId, CancellationToken cancellationToken = default) + public async Task> ListConversionsNextPageAsync(string nextLink, Guid accountId, CancellationToken cancellationToken = default) { if (nextLink == null) { @@ -687,7 +673,7 @@ public async Task Gets a list of all conversions. Returns a batch of conversions- if more conversions are available the @nextLink property contains the a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. + /// Gets a list of all conversions. /// The URL to the next page of results. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. /// is null. - public ResponseWithHeaders ListConversionsNextPage(string nextLink, Guid accountId, CancellationToken cancellationToken = default) + public ResponseWithHeaders ListConversionsNextPage(string nextLink, Guid accountId, CancellationToken cancellationToken = default) { if (nextLink == null) { @@ -716,7 +702,7 @@ public ResponseWithHeaders Get a list of all rendering sessions. + /// Gets a list of all rendering sessions. /// The URL to the next page of results. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. /// is null. public async Task> ListSessionsNextPageAsync(string nextLink, Guid accountId, CancellationToken cancellationToken = default) @@ -772,9 +758,9 @@ public async Task> ListSessionsNextPageAsync(string nextL } } - /// Get a list of all rendering sessions. + /// Gets a list of all rendering sessions. /// The URL to the next page of results. - /// the Azure Remote Rendering account id. + /// The Azure Remote Rendering account ID. /// The cancellation token to use. /// is null. public Response ListSessionsNextPage(string nextLink, Guid accountId, CancellationToken cancellationToken = default) diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateConversionHeaders.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingStopSessionHeaders.cs similarity index 76% rename from sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateConversionHeaders.cs rename to sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingStopSessionHeaders.cs index 1239371c4425..2a191b54e36d 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/MixedRealityRemoteRenderingCreateConversionHeaders.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/Generated/RemoteRenderingStopSessionHeaders.cs @@ -10,10 +10,10 @@ namespace Azure.MixedReality.RemoteRendering { - internal partial class MixedRealityRemoteRenderingCreateConversionHeaders + internal partial class RemoteRenderingStopSessionHeaders { private readonly Response _response; - public MixedRealityRemoteRenderingCreateConversionHeaders(Response response) + public RemoteRenderingStopSessionHeaders(Response response) { _response = response; } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/RemoteRenderingClient.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/RemoteRenderingClient.cs index d3d98834edcc..1ad6e41d33b0 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/RemoteRenderingClient.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/RemoteRenderingClient.cs @@ -21,7 +21,7 @@ public class RemoteRenderingClient private readonly HttpPipeline _pipeline; - private readonly MixedRealityRemoteRenderingRestClient _restClient; + private readonly RemoteRenderingRestClient _restClient; /// /// Initializes a new instance of the class. @@ -63,7 +63,7 @@ public RemoteRenderingClient(Uri remoteRenderingEndpoint, RemoteRenderingAccount _accountId = account.AccountId; _clientDiagnostics = new ClientDiagnostics(options); _pipeline = HttpPipelineBuilder.Build(options, new BearerTokenAuthenticationPolicy(mrTokenCredential, GetDefaultScope(remoteRenderingEndpoint))); - _restClient = new MixedRealityRemoteRenderingRestClient(_clientDiagnostics, _pipeline, remoteRenderingEndpoint.ToString(), options.Version); + _restClient = new RemoteRenderingRestClient(_clientDiagnostics, _pipeline, remoteRenderingEndpoint.ToString(), options.Version); } #pragma warning disable CS8618 // Non-nullable field is uninitialized. Consider declaring as nullable. diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/StartRenderingSessionOperation.cs b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/StartRenderingSessionOperation.cs index 95d0ed2b3585..353a58be37c9 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/StartRenderingSessionOperation.cs +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/StartRenderingSessionOperation.cs @@ -108,5 +108,10 @@ public async override ValueTask> WaitForCompletionAsy } return _response; } + + /// Initializes a new instance of StartRenderingSessionOperation for mocking. + protected StartRenderingSessionOperation() + { + } } } diff --git a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/autorest.md b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/autorest.md index e13210f16377..e29c794056a5 100644 --- a/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/autorest.md +++ b/sdk/mixedreality/Azure.MixedReality.RemoteRendering/src/autorest.md @@ -4,5 +4,5 @@ Run `dotnet build /t:GenerateCode` to generate code. ``` yaml input-file: - - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/883556bcd11ea4cc7525668c3e156dee49bc5b86/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json + - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/92aa7802beffd6bdae18b808e45c4897de2cb2e2/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json ```