Skip to content

Commit bb1f506

Browse files
author
Michael Zappe
committed
Update usage of powershell scripts
1 parent 5040c8c commit bb1f506

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

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

Lines changed: 8 additions & 5 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,15 @@ 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), except if you are running on a non-public Azure region, whereas 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.
9495
- **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).
96+
- **remoteRenderingDomain:** The region where the remote rendering VM will be setup in. Can differ from the arrAccountDomain, but still should be a region from [list of available regions](../reference/regions.md), except if you are running on a non-public Azure region, whereas you have to specify the full url to the remote rendering service in your region.
9597

9698
### assetConversionSettings
9799

@@ -125,7 +127,7 @@ To use an **alternative config** file:
125127
You can **override individual settings** from the config file:
126128

127129
```PowerShell
128-
.\RenderingSession.ps1 -Region <region> -VmSize <vmsize> -MaxLeaseTime <hh:mm:ss>
130+
.\RenderingSession.ps1 -ArrAccountDomain <arrAccountDomain> -RemoteRenderingDomain <remoteRenderingDomain> -VmSize <vmsize> -MaxLeaseTime <hh:mm:ss>
129131
```
130132

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

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

@@ -231,7 +233,8 @@ You can **override individual settings** from the config file using the followin
231233
* **Id:** ConversionId used with GetConversionStatus
232234
* **ArrAccountId:** arrAccountId of accountSettings
233235
* **ArrAccountKey:** override for arrAccountKey of accountSettings
234-
* **Region:** override for region of accountSettings
236+
* **ArrAccountDomain:** override for arrAccountDomain of accountSettings
237+
* **RemoteRenderingDomain:** override for remoteRenderingDomain of renderingSessionSettings
235238
* **ResourceGroup:** override for resourceGroup of assetConversionSettings
236239
* **StorageAccountName:** override for storageAccountName of assetConversionSettings
237240
* **BlobInputContainerName:** override for blobInputContainer of assetConversionSettings

0 commit comments

Comments
 (0)