Skip to content

Commit 5f57f98

Browse files
committed
priming - new screenshots, more APIs, text edits
1 parent 1c145c3 commit 5f57f98

File tree

5 files changed

+41
-14
lines changed

5 files changed

+41
-14
lines changed
225 KB
Loading
-111 KB
Binary file not shown.
73.9 KB
Loading
-56.7 KB
Binary file not shown.

articles/hpc-cache/prime-cache.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use the cache priming feature to populate or preload cache contents
44
author: ekpgh
55
ms.service: hpc-cache
66
ms.topic: how-to
7-
ms.date: 05/29/2022
7+
ms.date: 05/31/2022
88
ms.author: v-erinkelly
99
---
1010

@@ -180,8 +180,7 @@ The cache accesses the manifest file once when the priming job starts. The SAS U
180180

181181
Use the Azure portal to create a priming job. View your Azure HPC Cache in the portal and select the **Prime cache** page under the **Settings** heading.
182182

183-
![screenshot of the Priming page in the portal, with several completed jobs.](media/prime-overview.png)
184-
<!-- to do: screenshot with more diverse jobs and statuses -->
183+
![screenshot of the Priming page in the portal, with several jobs in various states.](media/prime-overview.png)
185184

186185
Click the **Add priming job** text at the top of the table to define a new job.
187186

@@ -199,19 +198,17 @@ If you can’t find the manifest file, your cache might not be able to access th
199198

200199
Priming jobs are listed in the **Prime cache** page in the Azure portal.
201200

202-
![screenshot of the priming jobs list in the portal, with jobs in various states (running, paused, and success). The cursor has clicked the ... symbol at the right side of one job's row, and a context menu shows options to pause or resume.](media/prime-cache-list.png)
201+
This page shows each job's name, its state, its current status, and summary statistics about the priming progress. The summary in the **Details** column updates periodically as the job progresses. The **Job status** field is populated when a priming job starts; this field also gives basic error information like **Invalid manifest** if a problem occurs.
203202

204-
This page shows each job's name, its state, its current status, and summary statistics about the priming progress. The summary in the **Details** column updates periodically as the job progresses. The **Status** field is populated when a priming job starts; this field also gives basic error information like **Invalid manifest** if a problem occurs.
203+
While a job is running, the **Percentage complete** column shows an estimate of the progress.
205204

206-
Before a priming job starts, it has the state **Queued**. Its **Status** and **Details** fields are empty.
205+
Before a priming job starts, it has the state **Queued**. Its **Job status**, **Percentage complete**, and **Details** fields are empty.
207206

208-
While a job is running, the column **Percentage complete** shows an estimate of the
207+
![screenshot of the priming jobs list in the portal, with jobs in various states (running, paused, and success). The cursor has clicked the ... symbol at the right side of one job's row, and a context menu shows options to pause or resume.](media/prime-cache-context.png)
209208

210-
![Screenshot of populated cache priming job table.](media/prime-percent-complete.png)
209+
Click the **...** section at the right of the table to pause or resume a priming job. (It might take a few minutes for the status to update.)
211210

212-
Click the **...** section at the right of the table to pause or resume a priming job.
213-
214-
To delete a priming job, select it in the list and use the delete control at the top of the table.
211+
To delete a priming job, select it in the list and use the **Stop** control at the top of the table. You can use the **Stop** control to delete a job in any state.
215212

216213
## Azure REST APIs
217214

@@ -241,7 +238,7 @@ For the `primingManifestUrl` value, pass the file’s SAS URL or other HTTPS URL
241238

242239
### Stop a priming job
243240

244-
The `stopPrimingJob` interface cancels a job (if it is running) and removes it from the job list.
241+
The `stopPrimingJob` interface cancels a job (if it is running) and removes it from the job list. Use this interface to delete a priming job in any state.
245242

246243
```rest
247244
@@ -270,7 +267,37 @@ BODY:
270267
271268
```
272269

273-
<!-- ***[ ?? should we add pause/resume APIs here too? ??]*** -->
270+
### Pause a priming job
271+
272+
The `pausePrimingJob` interface suspends a running job.
273+
274+
```rest
275+
276+
URL: POST
277+
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/pausePrimingJob?api-version=2022-05-01
278+
279+
BODY:
280+
{
281+
"primingJobId": "MY-JOB-ID-TO-PAUSE"
282+
}
283+
284+
```
285+
286+
### Resume a priming job
287+
288+
Use the `resumePrimingJob` interface to reactivate a suspended priming job.
289+
290+
```rest
291+
292+
URL: POST
293+
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/resumePrimingJob?api-version=2022-05-01
294+
295+
BODY:
296+
{
297+
"primingJobId": "MY-JOB-ID-TO-RESUME"
298+
}
299+
300+
```
274301

275302
## Frequently asked questions
276303

@@ -282,7 +309,7 @@ BODY:
282309

283310
* How long does a failed or completed priming job stay in the list?
284311

285-
Priming jobs persist in the list until you delete them. On the portal **Prime cache** page, check the checkbox next to the job and select the **Delete** control at the top of the list.
312+
Priming jobs persist in the list until you delete them. On the portal **Prime cache** page, check the checkbox next to the job and select the **Stop** control at the top of the list to delete the job.
286313

287314
* What happens if the content I’m pre-loading is larger than my cache storage?
288315

0 commit comments

Comments
 (0)