Skip to content

Commit b91d3cd

Browse files
bganapabganapa
authored
Merge pull request Azure#64 from ritviks/updateadmindocs
Adding Azs.Update Docs and Examples
2 parents a07a3bb + bb17f1d commit b91d3cd

11 files changed

+1213
-0
lines changed

‎src/Azs.Update.Admin/docs/Azs.Update.Admin.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
Module Name: Azs.Update.Admin
3+
Module Guid: 3f7f32a5-5fe8-4593-ac9a-3e696d01b5ed
4+
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azs.update.admin
5+
Help Version: 1.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# Azs.Update.Admin Module
10+
## Description
11+
Microsoft Azure PowerShell: UpdateAdmin cmdlets
12+
13+
## Azs.Update.Admin Cmdlets
14+
### [Get-AzsUpdate](Get-AzsUpdate.md)
15+
Get a specific update at an update location.
16+
17+
### [Get-AzsUpdateLocation](Get-AzsUpdateLocation.md)
18+
Get an update location based on name.
19+
20+
### [Get-AzsUpdateRun](Get-AzsUpdateRun.md)
21+
Get an instance of update run using the ID.
22+
23+
### [Install-AzsUpdate](Install-AzsUpdate.md)
24+
Apply a specific update at an update location.
25+
26+
### [Resume-AzsUpdateRun](Resume-AzsUpdateRun.md)
27+
Resume a failed update.
28+

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

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
---
2+
external help file:
3+
Module Name: Azs.Update.Admin
4+
online version: https://docs.microsoft.com/en-us/powershell/module/azs.update.admin/get-azsupdate
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzsUpdate
9+
10+
## SYNOPSIS
11+
Get a specific update at an update location.
12+
13+
## SYNTAX
14+
15+
### List (Default)
16+
```
17+
Get-AzsUpdate [-Location <String>] [-ResourceGroupName <String>] [-SubscriptionId <String[]>]
18+
[-DefaultProfile <PSObject>] [<CommonParameters>]
19+
```
20+
21+
### Get
22+
```
23+
Get-AzsUpdate -Name <String> [-Location <String>] [-ResourceGroupName <String>] [-SubscriptionId <String[]>]
24+
[-DefaultProfile <PSObject>] [<CommonParameters>]
25+
```
26+
27+
### GetViaIdentity
28+
```
29+
Get-AzsUpdate -InputObject <IUpdateAdminIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
Get a specific update at an update location.
34+
35+
## EXAMPLES
36+
37+
### Example 1: Get All Updates
38+
```powershell
39+
PS C:\> Get-AzsUpdate
40+
41+
Location DisplayName Name State Publisher
42+
-------- ----------- ---- ----- ---------
43+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
44+
northwest AzS Update - 1.1907.0.13 northwest/Microsoft1.1907.0.13 Installed Microsoft
45+
northwest AzS Update - 1.1907.0.20 northwest/Microsoft1.1907.0.20 Installed Microsoft
46+
```
47+
48+
Without any parameters, Get-AzsUpdate will list all updates that the stamp can discover
49+
50+
### Example 2: Get Update by Name
51+
```powershell
52+
PS C:\> Get-AzsUpdate -Name Microsoft1.1907.0.10
53+
or
54+
PS C:\> Get-AzsUpdate -Name northwest/Microsoft1.1907.0.10
55+
56+
57+
Location DisplayName Name State Publisher
58+
-------- ----------- ---- ----- ---------
59+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
60+
```
61+
62+
Will retrieve all updates that correspond to the specified Name
63+
64+
### Example 3: Get All Updates by Location
65+
```powershell
66+
PS C:\> Get-AzsUpdate -Location northwest
67+
68+
Location DisplayName Name State Publisher
69+
-------- ----------- ---- ----- ---------
70+
northwest AzS Update - 1.1907.0.10 northwest/Microsoft1.1907.0.10 Installed Microsoft
71+
northwest AzS Update - 1.1907.0.13 northwest/Microsoft1.1907.0.13 Installed Microsoft
72+
northwest AzS Update - 1.1907.0.20 northwest/Microsoft1.1907.0.20 Installed Microsoft
73+
```
74+
75+
Will retrieve all updates within a specified Location.
76+
Currently, only one location is supported so this is the equivalent as just Get-AzsUpdate
77+
78+
## PARAMETERS
79+
80+
### -DefaultProfile
81+
The credentials, account, tenant, and subscription used for communication with Azure.
82+
83+
```yaml
84+
Type: System.Management.Automation.PSObject
85+
Parameter Sets: (All)
86+
Aliases: AzureRMContext, AzureCredential
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
Dynamic: False
94+
```
95+
96+
### -InputObject
97+
Identity Parameter
98+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
99+
100+
```yaml
101+
Type: Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.IUpdateAdminIdentity
102+
Parameter Sets: GetViaIdentity
103+
Aliases:
104+
105+
Required: True
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: True (ByValue)
109+
Accept wildcard characters: False
110+
Dynamic: False
111+
```
112+
113+
### -Location
114+
The name of the update location.
115+
116+
```yaml
117+
Type: System.String
118+
Parameter Sets: Get, List
119+
Aliases:
120+
121+
Required: False
122+
Position: Named
123+
Default value: (Get-AzLocation)[0].Location
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
Dynamic: False
127+
```
128+
129+
### -Name
130+
Name of the update.
131+
132+
```yaml
133+
Type: System.String
134+
Parameter Sets: Get
135+
Aliases:
136+
137+
Required: True
138+
Position: Named
139+
Default value: None
140+
Accept pipeline input: False
141+
Accept wildcard characters: False
142+
Dynamic: False
143+
```
144+
145+
### -ResourceGroupName
146+
Resource group name.
147+
148+
```yaml
149+
Type: System.String
150+
Parameter Sets: Get, List
151+
Aliases:
152+
153+
Required: False
154+
Position: Named
155+
Default value: -join("System.",(Get-AzLocation)[0].Location)
156+
Accept pipeline input: False
157+
Accept wildcard characters: False
158+
Dynamic: False
159+
```
160+
161+
### -SubscriptionId
162+
Subscription credentials which uniquely identify Microsoft Azure subscription.
163+
The subscription ID forms part of the URI for every service call.
164+
165+
```yaml
166+
Type: System.String[]
167+
Parameter Sets: Get, List
168+
Aliases:
169+
170+
Required: False
171+
Position: Named
172+
Default value: (Get-AzContext).Subscription.Id
173+
Accept pipeline input: False
174+
Accept wildcard characters: False
175+
Dynamic: False
176+
```
177+
178+
### CommonParameters
179+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
180+
181+
## INPUTS
182+
183+
### Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.IUpdateAdminIdentity
184+
185+
## OUTPUTS
186+
187+
### Microsoft.Azure.PowerShell.Cmdlets.UpdateAdmin.Models.Api20160501.IUpdate
188+
189+
## ALIASES
190+
191+
## NOTES
192+
193+
### COMPLEX PARAMETER PROPERTIES
194+
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
195+
196+
#### INPUTOBJECT <IUpdateAdminIdentity>: Identity Parameter
197+
- `[Id <String>]`: Resource identity path
198+
- `[ResourceGroupName <String>]`: Resource group name.
199+
- `[RunName <String>]`: Update run identifier.
200+
- `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
201+
- `[UpdateLocation <String>]`: The name of the update location.
202+
- `[UpdateName <String>]`: Name of the update.
203+
204+
## RELATED LINKS
205+

0 commit comments

Comments
 (0)