Skip to content

Commit e77dfab

Browse files
committed
Added job agent help documentation
1 parent d8056f3 commit e77dfab

File tree

3 files changed

+59
-13
lines changed

3 files changed

+59
-13
lines changed

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

+35-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzureRmSqlJobAgent
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Gets one or more job agents in a server.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,46 @@ Get-AzureRmSqlJobAgent [-ServerName] <String> [[-JobAgentName] <String>] [-Resou
1818
```
1919

2020
## DESCRIPTION
21-
{{Fill in the Description}}
21+
The **Get-AzureRmSqlJobAgent** cmdlet gets one or more Azure SQL job accounts from an Azure SQL Database Server.
2222

2323
## EXAMPLES
2424

25-
### Example 1
25+
### Example 1: Get all job agents in a server
2626
```powershell
27-
PS C:\> {{ Add example code here }}
27+
PS C:\> Get-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1
28+
29+
30+
ResourceGroupName : rg1
31+
ServerName : server1
32+
JobAgentName : agent1
33+
Location : centralus
34+
DatabaseName : db1
35+
Tags :
36+
37+
ResourceGroupName : rg1
38+
ServerName : server1
39+
JobAgentName : agent2
40+
Location : centralus
41+
DatabaseName : db2
42+
Tags :
2843
```
2944

30-
{{ Add example description here }}
45+
This command gets all job agents in the server named server1.
46+
47+
### Example 2: Get a job agent by name
48+
```powershell
49+
PS C:\> Get-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1
50+
51+
52+
ResourceGroupName : rg1
53+
ServerName : server1
54+
JobAgentName : agent1
55+
Location : centralus
56+
DatabaseName : db1
57+
Tags :
58+
```
59+
60+
This command gets a job agent named agent1 in the server named server1.
3161

3262
## PARAMETERS
3363

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

+12-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzureRmSqlJobAgent
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Creates a new job agent.
1212

1313
## SYNTAX
1414

@@ -19,16 +19,24 @@ New-AzureRmSqlJobAgent -ServerName <String> -JobAgentName <String> -DatabaseName
1919
```
2020

2121
## DESCRIPTION
22-
{{Fill in the Description}}
22+
The **New-AzureRmSqlJobAgent** cmdlet creates an Azure SQL job account. The job agent must be linked to an existing Azure SQL database where the job definitions, status, and history will be stored.
2323

2424
## EXAMPLES
2525

2626
### Example 1
2727
```powershell
28-
PS C:\> {{ Add example code here }}
28+
PS C:\> New-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1 -DatabaseName db1
29+
30+
31+
ResourceGroupName : rg1
32+
ServerName : server1
33+
JobAgentName : agent1
34+
Location : centralus
35+
DatabaseName : db1
36+
Tags :
2937
```
3038

31-
{{ Add example description here }}
39+
This command creates a new job agents in the server named server1. The job definitions, status, and history will be stored in the database named db1.
3240

3341
## PARAMETERS
3442

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

+12-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Remove-AzureRmSqlJobAgent
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Deletes a job agent.
1212

1313
## SYNTAX
1414

@@ -19,16 +19,24 @@ Remove-AzureRmSqlJobAgent [-ServerName] <String> [-JobAgentName] <String> [-Forc
1919
```
2020

2121
## DESCRIPTION
22-
{{Fill in the Description}}
22+
The **Remove-AzureRmSqlJobAgent** cmdlet deletes an Azure SQL job agent.
2323

2424
## EXAMPLES
2525

2626
### Example 1
2727
```powershell
28-
PS C:\> {{ Add example code here }}
28+
PS C:\> Remove-AzureRmSqlJobAgent -ResourceGroupName rg1 -ServerName server1 -JobAgentName agent1
29+
30+
31+
ResourceGroupName : rg1
32+
ServerName : server1
33+
JobAgentName : agent1
34+
Location : centralus
35+
DatabaseName : db1
36+
Tags :
2937
```
3038

31-
{{ Add example description here }}
39+
This command deletes a job agent named agent1 in the server named server1.
3240

3341
## PARAMETERS
3442

0 commit comments

Comments
 (0)