Skip to content

Commit 8b16e69

Browse files
committed
Regen jobagent help
1 parent 50943fc commit 8b16e69

File tree

4 files changed

+79
-20
lines changed

4 files changed

+79
-20
lines changed

src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md

+9
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,9 @@ Gets elastic pool recommendations.
107107
### [Get-AzureRmSqlElasticPoolRecommendedAction](Get-AzureRmSqlElasticPoolRecommendedAction.md)
108108
Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor.
109109

110+
### [Get-AzureRmSqlJobAgent](Get-AzureRmSqlJobAgent.md)
111+
Gets one or more job agents in a server.
112+
110113
### [Get-AzureRmSqlServer](Get-AzureRmSqlServer.md)
111114
Returns information about SQL Database servers.
112115

@@ -206,6 +209,9 @@ Creates a secondary database for an existing database and starts data replicatio
206209
### [New-AzureRmSqlElasticPool](New-AzureRmSqlElasticPool.md)
207210
Creates an elastic database pool for a SQL Database.
208211

212+
### [New-AzureRmSqlJobAgent](New-AzureRmSqlJobAgent.md)
213+
Creates a new job agent.
214+
209215
### [New-AzureRmSqlServer](New-AzureRmSqlServer.md)
210216
Creates a SQL Database server.
211217

@@ -260,6 +266,9 @@ Removes the threat detection policy from a database.
260266
### [Remove-AzureRmSqlElasticPool](Remove-AzureRmSqlElasticPool.md)
261267
Deletes an elastic database pool.
262268

269+
### [Remove-AzureRmSqlJobAgent](Remove-AzureRmSqlJobAgent.md)
270+
Deletes a job agent.
271+
263272
### [Remove-AzureRmSqlServer](Remove-AzureRmSqlServer.md)
264273
Removes an Azure SQL Database server.
265274

src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlJobAgent.md

+34-6
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets one or more job agents in a server.
1414

1515
```
1616
Get-AzureRmSqlJobAgent [-ServerName] <String> [[-JobAgentName] <String>] [-ResourceGroupName] <String>
17-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
17+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -23,7 +23,7 @@ The **Get-AzureRmSqlJobAgent** cmdlet gets one or more Azure SQL job accounts fr
2323
## EXAMPLES
2424

2525
### Example 1: Get all job agents in a server
26-
```powershell
26+
```
2727
PS C:\> Get-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1
2828
2929
@@ -45,7 +45,7 @@ Tags :
4545
This command gets all job agents in the server named server1.
4646

4747
### Example 2: Get a job agent by name
48-
```powershell
48+
```
4949
PS C:\> Get-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1
5050
5151
@@ -121,15 +121,43 @@ Accept pipeline input: True (ByPropertyName)
121121
Accept wildcard characters: False
122122
```
123123
124+
### -Confirm
125+
Prompts you for confirmation before running the cmdlet.
126+
127+
```yaml
128+
Type: SwitchParameter
129+
Parameter Sets: (All)
130+
Aliases: cf
131+
132+
Required: False
133+
Position: Named
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
### -WhatIf
140+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
141+
142+
```yaml
143+
Type: SwitchParameter
144+
Parameter Sets: (All)
145+
Aliases: wi
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
124154
### CommonParameters
125-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
126-
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
155+
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).
127156
128157
## INPUTS
129158
130159
### System.String
131160
132-
133161
## OUTPUTS
134162
135163
### System.Object

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlJobAgent.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Creates a new job agent.
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmSqlJobAgent -ServerName <String> -JobAgentName <String> -DatabaseName <String>
17-
[-Tags <System.Collections.Generic.Dictionary`2[System.String,System.String]>] [-ResourceGroupName] <String>
18-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
16+
New-AzureRmSqlJobAgent -ServerName <String> -JobAgentName <String> -DatabaseName <String> [-Tags <Hashtable>]
17+
[-AsJob] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
18+
[<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -24,7 +24,7 @@ The **New-AzureRmSqlJobAgent** cmdlet creates an Azure SQL job account. The job
2424
## EXAMPLES
2525

2626
### Example 1
27-
```powershell
27+
```
2828
PS C:\> New-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1 -DatabaseName db1
2929
3030
@@ -40,6 +40,19 @@ This command creates a new job agents in the server named server1. The job defin
4040

4141
## PARAMETERS
4242

43+
### -AsJob
44+
Run cmdlet in the background```yaml
45+
Type: SwitchParameter
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
4356
### -DatabaseName
4457
SQL Database database name.
4558
@@ -119,9 +132,9 @@ Accept wildcard characters: False
119132
The tags to associate with the Azure Sql Job Account
120133
121134
```yaml
122-
Type: System.Collections.Generic.Dictionary`2[System.String,System.String]
135+
Type: Hashtable
123136
Parameter Sets: (All)
124-
Aliases:
137+
Aliases: Tag
125138

126139
Required: False
127140
Position: Named
@@ -162,14 +175,12 @@ Accept wildcard characters: False
162175
```
163176
164177
### CommonParameters
165-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
166-
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
178+
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).
167179
168180
## INPUTS
169181
170182
### System.String
171183
172-
173184
## OUTPUTS
174185
175186
### System.Object

src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlJobAgent.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Deletes a job agent.
1313
## SYNTAX
1414

1515
```
16-
Remove-AzureRmSqlJobAgent [-ServerName] <String> [-JobAgentName] <String> [-Force]
16+
Remove-AzureRmSqlJobAgent [-ServerName] <String> [-JobAgentName] <String> [-Force] [-AsJob]
1717
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1818
[<CommonParameters>]
1919
```
@@ -24,7 +24,7 @@ The **Remove-AzureRmSqlJobAgent** cmdlet deletes an Azure SQL job agent.
2424
## EXAMPLES
2525

2626
### Example 1
27-
```powershell
27+
```
2828
PS C:\> Remove-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1
2929
3030
@@ -40,6 +40,19 @@ This command deletes a job agent named agent1 in the server named server1.
4040

4141
## PARAMETERS
4242

43+
### -AsJob
44+
Run cmdlet in the background```yaml
45+
Type: SwitchParameter
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
4356
### -DefaultProfile
4457
The credentials, account, tenant, and subscription used for communication with Azure.
4558
@@ -147,14 +160,12 @@ Accept wildcard characters: False
147160
```
148161
149162
### CommonParameters
150-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
151-
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
163+
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).
152164
153165
## INPUTS
154166
155167
### System.String
156168
157-
158169
## OUTPUTS
159170
160171
### System.Object

0 commit comments

Comments
 (0)