You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/remote-rendering/samples/powershell-example-scripts.md
+15-10Lines changed: 15 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,9 +55,10 @@ Next to the `.ps1` files there's an `arrconfig.json` that you need to fill out:
55
55
"accountSettings": {
56
56
"arrAccountId": "<fill in the account ID from the Azure Portal>",
57
57
"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>"
59
59
},
60
60
"renderingSessionSettings": {
61
+
"remoteRenderingDomain": "<select from available regions or specify the full url>",
61
62
"vmSize": "<select standard or premium>",
62
63
"maxLeaseTime": "<hh:mm:ss>"
63
64
},
@@ -84,14 +85,17 @@ Next to the `.ps1` files there's an `arrconfig.json` that you need to fill out:
84
85
### accountSettings
85
86
86
87
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.
88
89
89
90
### renderingSessionSettings
90
91
91
92
This structure must be filled out if you want to run **RenderingSession.ps1**:
92
93
93
94
-**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.
95
99
96
100
### assetConversionSettings
97
101
@@ -114,7 +118,7 @@ Normal usage with a fully filled out arrconfig.json:
114
118
.\RenderingSession.ps1
115
119
```
116
120
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.
118
122
119
123
To use an **alternative config** file:
120
124
@@ -125,7 +129,7 @@ To use an **alternative config** file:
125
129
You can **override individual settings** from the config file:
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.
174
178
This script is used to convert input models into the Azure Remote Rendering specific runtime format.
175
179
176
180
> [!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.
178
182
179
183
The script demonstrates the two options to use storage accounts with the service:
180
184
@@ -191,7 +195,7 @@ Using a linked storage account is the preferred way to use the conversion servic
191
195
.\Conversion.ps1
192
196
```
193
197
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`.
195
199
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)
196
200
1. Poll the conversion status until the conversion succeeded or failed.
197
201
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
231
235
***Id:** ConversionId used with GetConversionStatus
232
236
***ArrAccountId:** arrAccountId of accountSettings
233
237
***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
235
240
***ResourceGroup:** override for resourceGroup of assetConversionSettings
236
241
***StorageAccountName:** override for storageAccountName of assetConversionSettings
237
242
***BlobInputContainerName:** override for blobInputContainer of assetConversionSettings
@@ -241,7 +246,7 @@ You can **override individual settings** from the config file using the followin
241
246
***OutputFolderPath:** override for the outputFolderPath of assetConversionSettings
242
247
***OutputAssetFileName:** override for outputAssetFileName of assetConversionSettings
243
248
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:
0 commit comments