Skip to content

Commit ef624ad

Browse files
Merge pull request #231183 from MichaelZp0/MichaelZp0/AdjustPowershellScriptUsage
Update usage of powershell scripts
2 parents d5406d3 + b5f765e commit ef624ad

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

articles/remote-rendering/samples/powershell-example-scripts.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@ Next to the `.ps1` files there's an `arrconfig.json` that you need to fill out:
5555
"accountSettings": {
5656
"arrAccountId": "<fill in the account ID from the Azure Portal>",
5757
"arrAccountKey": "<fill in the account key from the Azure Portal>",
58-
"region": "<select from available regions>"
58+
"arrAccountDomain": "<select from available regions or specify the full url>"
5959
},
6060
"renderingSessionSettings": {
61+
"remoteRenderingDomain": "<select from available regions or specify the full url>",
6162
"vmSize": "<select standard or premium>",
6263
"maxLeaseTime": "<hh:mm:ss>"
6364
},
@@ -84,14 +85,17 @@ Next to the `.ps1` files there's an `arrconfig.json` that you need to fill out:
8485
### accountSettings
8586

8687
For `arrAccountId` and `arrAccountKey`, see [Create an Azure Remote Rendering account](../how-tos/create-an-account.md).
87-
For `region` see the [list of available regions](../reference/regions.md).
88+
The `arrAccountDomain` should be a region from [list of available regions](../reference/regions.md). If you're running on a nonpublic Azure region, you have to specify the full url to the account authentication service in your region.
8889

8990
### renderingSessionSettings
9091

9192
This structure must be filled out if you want to run **RenderingSession.ps1**:
9293

9394
- **vmSize:** Selects the size of the virtual machine. Select [*standard*](../reference/vm-sizes.md) or [*premium*](../reference/vm-sizes.md). Shut down rendering sessions when you don't need them anymore.
94-
- **maxLeaseTime:** The duration for which you want to lease the VM. It will be shut down when the lease expires. The lease time can be extended later (see below).
95+
- **maxLeaseTime:** The duration for which you want to lease the VM. The VM shuts down when the lease expires. The lease time can be extended later (see [here](#change-session-properties)).
96+
- **remoteRenderingDomain:** The region where the remote rendering VM resides in.
97+
- Can differ from the arrAccountDomain, but still should be a region from [list of available regions](../reference/regions.md)
98+
- If you're running on a nonpublic Azure region, you have to specify the full url to the remote rendering service in your region.
9599

96100
### assetConversionSettings
97101

@@ -114,7 +118,7 @@ Normal usage with a fully filled out arrconfig.json:
114118
.\RenderingSession.ps1
115119
```
116120

117-
The script will call the [session management REST API](../how-tos/session-rest-api.md) to spin up a rendering VM with the specified settings. On success, it will retrieve the *sessionId*. Then it will poll the session properties until the session is ready or an error occurred.
121+
The script calls the [session management REST API](../how-tos/session-rest-api.md) to spin up a rendering VM with the specified settings. On success, it retrieves the *sessionId*. Afterwards it polls the session properties until the session is ready or an error occurred.
118122

119123
To use an **alternative config** file:
120124

@@ -125,7 +129,7 @@ To use an **alternative config** file:
125129
You can **override individual settings** from the config file:
126130

127131
```PowerShell
128-
.\RenderingSession.ps1 -Region <region> -VmSize <vmsize> -MaxLeaseTime <hh:mm:ss>
132+
.\RenderingSession.ps1 -ArrAccountDomain <arrAccountDomain> -RemoteRenderingDomain <remoteRenderingDomain> -VmSize <vmsize> -MaxLeaseTime <hh:mm:ss>
129133
```
130134

131135
To only **start a session without polling**, you can use:
@@ -174,7 +178,7 @@ At the moment, we only support changing the maxLeaseTime of a session.
174178
This script is used to convert input models into the Azure Remote Rendering specific runtime format.
175179

176180
> [!IMPORTANT]
177-
> Make sure you have filled out the *accountSettings* and *assetConversionSettings* sections in arrconfig.json.
181+
> Make sure you have filled out the *accountSettings* and *assetConversionSettings* sections, and the *remoteRenderingDomain* option in the *renderingSessionSettings* in arrconfig.json.
178182
179183
The script demonstrates the two options to use storage accounts with the service:
180184

@@ -191,7 +195,7 @@ Using a linked storage account is the preferred way to use the conversion servic
191195
.\Conversion.ps1
192196
```
193197

194-
1. Upload all files contained in the `assetConversionSettings.modelLocation` to the input blob container under the given `inputFolderPath`..
198+
1. Upload all files contained in the `assetConversionSettings.modelLocation` to the input blob container under the given `inputFolderPath`.
195199
1. Call the [model conversion REST API](../how-tos/conversion/conversion-rest-api.md) to kick off the [model conversion](../how-tos/conversion/model-conversion.md)
196200
1. Poll the conversion status until the conversion succeeded or failed.
197201
1. Output details of the converted file location (storage account, output container, file path in the container).
@@ -231,7 +235,8 @@ You can **override individual settings** from the config file using the followin
231235
* **Id:** ConversionId used with GetConversionStatus
232236
* **ArrAccountId:** arrAccountId of accountSettings
233237
* **ArrAccountKey:** override for arrAccountKey of accountSettings
234-
* **Region:** override for region of accountSettings
238+
* **ArrAccountDomain:** override for arrAccountDomain of accountSettings
239+
* **RemoteRenderingDomain:** override for remoteRenderingDomain of renderingSessionSettings
235240
* **ResourceGroup:** override for resourceGroup of assetConversionSettings
236241
* **StorageAccountName:** override for storageAccountName of assetConversionSettings
237242
* **BlobInputContainerName:** override for blobInputContainer of assetConversionSettings
@@ -241,7 +246,7 @@ You can **override individual settings** from the config file using the followin
241246
* **OutputFolderPath:** override for the outputFolderPath of assetConversionSettings
242247
* **OutputAssetFileName:** override for outputAssetFileName of assetConversionSettings
243248

244-
For example you can combine a number of the given options like this:
249+
For example you can combine the given options like this:
245250

246251
```PowerShell
247252
.\Conversion.ps1 -LocalAssetDirectoryPath "C:\\models\\box" -InputAssetPath box.fbx -OutputFolderPath another/converted/box -OutputAssetFileName newConversionBox.arrAsset
@@ -258,7 +263,7 @@ Only upload data from the given LocalAssetDirectoryPath.
258263
```
259264

260265
Only start the conversion process of a model already uploaded to blob storage (don't run Upload, don't poll the conversion status)
261-
The script will return a *conversionId*.
266+
The script returns a *conversionId*.
262267

263268
```PowerShell
264269
.\Conversion.ps1 -ConvertAsset

0 commit comments

Comments
 (0)