Skip to content

Commit 86573c9

Browse files
author
Ritvik Salim
committed
Made Examples
1 parent 782cf70 commit 86573c9

File tree

5 files changed

+83
-52
lines changed

5 files changed

+83
-52
lines changed

‎src/Azs.Update.Admin/examples/Get-AzsUpdate.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Get All Updates
22
```powershell
3-
PS C:\> {{ Add code here }}
3+
PS C:\> Get-AzsUpdate
44
5-
{{ Add output here }}
5+
Location DisplayName Name State Publisher
6+
-------- ----------- ---- ----- ---------
7+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
8+
northwest AzS Update - 1.1907.0.13 northwest/Microsoft1.1907.0.13 Installed Microsoft
9+
northwest AzS Update - 1.1907.0.20 northwest/Microsoft1.1907.0.20 Installed Microsoft
610
```
711

8-
{{ Add description here }}
12+
Without any parameters, Get-AzsUpdate will list all updates that the stamp can discover
913

10-
### Example 2: {{ Add title here }}
14+
### Example 2: Get Update by Name
1115
```powershell
12-
PS C:\> {{ Add code here }}
16+
PS C:\> Get-AzsUpdate -Name Microsoft1.1907.0.10
17+
or
18+
PS C:\> Get-AzsUpdate -Name northwest/Microsoft1.1907.0.10
1319
14-
{{ Add output here }}
20+
21+
Location DisplayName Name State Publisher
22+
-------- ----------- ---- ----- ---------
23+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
1524
```
1625

17-
{{ Add description here }}
26+
Will retrieve all updates that correspond to the specified Name
27+
28+
29+
### Example 3: Get All Updates by Location
30+
```powershell
31+
PS C:\> Get-AzsUpdate -Location northwest
32+
33+
Location DisplayName Name State Publisher
34+
-------- ----------- ---- ----- ---------
35+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
36+
northwest AzS Update - 1.1907.0.13 northwest/Microsoft1.1907.0.13 Installed Microsoft
37+
northwest AzS Update - 1.1907.0.20 northwest/Microsoft1.1907.0.20 Installed Microsoft
38+
```
1839

40+
Will retrieve all updates within a specified Location. Currently, only one location is supported so this is the equivalent as just Get-AzsUpdate

‎src/Azs.Update.Admin/examples/Get-AzsUpdateLocation.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Get All Updates Locations
22
```powershell
3-
PS C:\> {{ Add code here }}
3+
PS C:\> Get-AzsUpdateLocation
44
5-
{{ Add output here }}
5+
Name CurrentVersion CurrentOemVersion State
6+
---- -------------- ----------------- -----
7+
northwest 1.1912.0.30 2.1.1907.4 AppliedSuccessfully
68
```
79

8-
{{ Add description here }}
10+
Without any parameters, this commandlet will retrieve all update locations
911

10-
### Example 2: {{ Add title here }}
12+
### Example 2: Get All Updates Locations by Name
1113
```powershell
12-
PS C:\> {{ Add code here }}
14+
PS C:\> Get-AzsUpdateLocation -Name northwest
1315
14-
{{ Add output here }}
16+
Name CurrentVersion CurrentOemVersion State
17+
---- -------------- ----------------- -----
18+
northwest 1.1912.0.30 2.1.1907.4 AppliedSuccessfully
1519
```
1620

17-
{{ Add description here }}
21+
Will retrieve all update locations that matches the specified Name parameter
1822

‎src/Azs.Update.Admin/examples/Get-AzsUpdateRun.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,43 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Get-AzsUpdateRun
22
```powershell
3-
PS C:\> {{ Add code here }}
3+
PS C:\> Get-AzsUpdateRun
44
5-
{{ Add output here }}
5+
cmdlet Get-AzsUpdateRun at command pipeline position 1
6+
Supply values for the following parameters:
7+
UpdateName: Microsoft1.1907.0.10
8+
9+
Name State ProgressStartTimeUtc ProgressEndTimeUtc
10+
---- ----- -------------------- ------------------
11+
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
12+
northwest/Microsoft1.1907.0.10/51e878... Succeeded 7/11/2019 3:07:10 PM 7/12/2019 6:47:37 AM
13+
```
14+
15+
If a UpdateName value is not specified, Get-UpdateRun will always ask for input. Once provided, it will output all instances of UpdateRun that were Failed or Successfull
16+
17+
### Example 2: Get-AzsUpdateRun By UpdateName
18+
```powershell
19+
PS C:\> Get-AzsUpdateRun -UpdateName Microsoft1.1907.0.10
20+
or
21+
PS C:\> Get-AzsUpdateRun -UpdateName northwest/Microsoft1.1907.0.10
22+
23+
Name State ProgressStartTimeUtc ProgressEndTimeUtc
24+
---- ----- -------------------- ------------------
25+
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
26+
northwest/Microsoft1.1907.0.10/51e878... Succeeded 7/11/2019 3:07:10 PM 7/12/2019 6:47:37 AM
627
```
728

8-
{{ Add description here }}
29+
Will retrieve all UpdateRuns associated with a specific Update
930

10-
### Example 2: {{ Add title here }}
31+
### Example 2: Get-AzsUpdateRun By Name
1132
```powershell
12-
PS C:\> {{ Add code here }}
33+
PS C:\> Get-AzsUpdateRun -UpdateName Microsoft1.1907.0.10 -Name 45aaeb26-805b-495b-9c8c-d5da5542dbf4
34+
or
35+
PS C:\> Get-AzsUpdateRun -UpdateName northwest/Microsoft1.1907.0.10 -Name northwest/Microsoft1.1907.0.10/45aaeb26-805b-495b-9c8c-d5da5542dbf4
1336
14-
{{ Add output here }}
37+
Name State ProgressStartTimeUtc ProgressEndTimeUtc
38+
---- ----- -------------------- ------------------
39+
northwest/Microsoft1.1907.0.10/45aaeb... Failed 7/11/2019 3:07:10 PM 7/11/2019 7:38:05 PM
1540
```
1641

17-
{{ Add description here }}
42+
Will retrieve all UpdateRuns associated with a specific Update and a specific Name
1843

‎src/Azs.Update.Admin/examples/Install-AzsUpdate.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,7 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Install-AzsUpdate By Name
22
```powershell
3-
PS C:\> {{ Add code here }}
4-
5-
{{ Add output here }}
3+
PS C:\> Install-AzsUpdate -Name Microsoft1.1907.0.10
64
```
75

8-
{{ Add description here }}
9-
10-
### Example 2: {{ Add title here }}
11-
```powershell
12-
PS C:\> {{ Add code here }}
13-
14-
{{ Add output here }}
15-
```
16-
17-
{{ Add description here }}
18-
6+
Commandlet allows you to install specific updates by name.
7+
Note that there is a requirement that the update version is strictly greater than the current version.

‎src/Azs.Update.Admin/examples/Resume-AzsUpdateRun.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Resume-AzsUpdateRun By Name and UpdateName
22
```powershell
3-
PS C:\> {{ Add code here }}
3+
PS C:\> Resume-AzsUpdateRun -UpdateName northwest/Microsoft1.1907.0.10 -Name 45aaeb26-805b-495b-9c8c-d5da5542dbf4
44
5-
{{ Add output here }}
65
```
76

8-
{{ Add description here }}
9-
10-
### Example 2: {{ Add title here }}
11-
```powershell
12-
PS C:\> {{ Add code here }}
13-
14-
{{ Add output here }}
15-
```
16-
17-
{{ Add description here }}
7+
Commandlet allows you to rerun a specific failed update run.
8+
Note that there is a requirement that the update version is strictly greater than the current version.
189

0 commit comments

Comments
 (0)