Skip to content

Commit 87675df

Browse files
v-yuzhichenZiyue ZhengBethanyZhou
authored
split Az.Automation exeamples (Azure#16950)
* split Az.Automation exeamples * Split Az.Automation axeamples * split Az.Automation exeamples * resolve some conflicts * resolve some conflicts * Update Get-AzAutomationSourceControlSyncJobOutput.md Co-authored-by: Ziyue Zheng <[email protected]> Co-authored-by: Beisi Zhou <[email protected]>
1 parent 14254a3 commit 87675df

File tree

86 files changed

+338
-329
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+338
-329
lines changed

src/Automation/Automation/help/Export-AzAutomationDscConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The exported file has a .ps1 file name extension.
2626
## EXAMPLES
2727

2828
### Example 1: Export the published version of a DSC configuration
29-
```
30-
PS C:\>Export-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Name "Configuration01" -Slot Published -OutputFolder "C:\Users\PattiFuller\Desktop"
29+
```powershell
30+
Export-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Name "Configuration01" -Slot Published -OutputFolder "C:\Users\PattiFuller\Desktop"
3131
```
3232

3333
This command exports the published version of a DSC configuration in Automation to the specified folder, which is the desktop.

src/Automation/Automation/help/Export-AzAutomationDscNodeReportContent.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ A DSC node sends a DSC report to Azure Automation.
2626
## EXAMPLES
2727

2828
### Example 1: Export a report from a DSC node
29-
```
30-
PS C:\>$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "AutomationAccount01" -Name "Computer14"
31-
PS C:\> $Report = Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "ContosoAutomationAccount" -NodeId $Node.Id -Latest
32-
PS C:\> $Report | Export-AzAutomationDscNodeReportContent -OutputFolder "C:\Users\PattiFuller\Desktop"
29+
```powershell
30+
$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "AutomationAccount01" -Name "Computer14"
31+
$Report = Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "ContosoAutomationAccount" -NodeId $Node.Id -Latest
32+
$Report | Export-AzAutomationDscNodeReportContent -OutputFolder "C:\Users\PattiFuller\Desktop"
3333
```
3434

3535
This set of commands exports the latest report from the DSC node named Computer14 to the desktop.

src/Automation/Automation/help/Export-AzAutomationRunbook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The name of the runbook becomes the name of the exported file.
2626
## EXAMPLES
2727

2828
### Example 1: Export a runbook
29-
```
30-
PS C:\>Export-AzAutomationRunbook -ResourceGroupName "ResourceGroup01" -AutomationAccountName "ContosoAutomationAccount" -Name "Runbook03" -Slot "Published" -OutputFolder "C:\Users\PattiFuller\Desktop"
29+
```powershell
30+
Export-AzAutomationRunbook -ResourceGroupName "ResourceGroup01" -AutomationAccountName "ContosoAutomationAccount" -Name "Runbook03" -Slot "Published" -OutputFolder "C:\Users\PattiFuller\Desktop"
3131
```
3232

3333
This command exports the published version of an Automation runbook to a user desktop.

src/Automation/Automation/help/Get-AzAutomationAccount.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ For more information about Automation accounts, see the New-AzAutomationAccount
3232
## EXAMPLES
3333

3434
### Example 1: Get all accounts
35-
```
36-
PS C:\>Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03"
35+
```powershell
36+
Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03"
3737
```
3838

3939
This command gets all Automation accounts in the resource group named ResourceGroup03.
4040

4141
### Example 2: Get an account
42-
```
43-
PS C:\>Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03" -Name "ContosoAutomationAccount"
42+
```powershell
43+
Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03" -Name "ContosoAutomationAccount"
4444
```
4545

4646
This command gets the Automation account named ContosoAutomationAccount in the resource group named ContosoResourceGroup.

src/Automation/Automation/help/Get-AzAutomationCertificate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ Specify the name of a certificate to get a specific certificate.
3333
## EXAMPLES
3434

3535
### Example 1: Get all certificates
36-
```
37-
PS C:\>Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17"
36+
```powershell
37+
Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17"
3838
```
3939

4040
This command gets metadata for all certificates in the Automation account named Contoso17.
4141

4242
### Example 2: Get a certificate
43-
```
44-
PS C:\>Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" -Name "ContosoCertificate"
43+
```powershell
44+
Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" -Name "ContosoCertificate"
4545
```
4646

4747
This command gets metadata for the certificate named ContosoCertificate.

src/Automation/Automation/help/Get-AzAutomationConnection.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,23 @@ Specify the connection type name to get all connections of a specific type.
4040
## EXAMPLES
4141

4242
### Example 1: Get all connections
43-
```
44-
PS C:\>Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
43+
```powershell
44+
Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
4545
```
4646

4747
This command gets metadata for all connections in the Automation account named Contoso17.
4848

4949
### Example 2: Get all connections of a type
50-
```
51-
PS C:\>Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -ConnectionTypeName "SqlServer"
50+
```powershell
51+
Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -ConnectionTypeName "SqlServer"
5252
```
5353

5454
This command gets metadata for connections in the Automation account named Contoso17.
5555
This command gets connections of the type SqlServer.
5656

5757
### Example 3: Get a connection
58-
```
59-
PS C:\>Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoConnection"
58+
```powershell
59+
Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoConnection"
6060
```
6161

6262
This command gets metadata for the connection named ContosoConnection.

src/Automation/Automation/help/Get-AzAutomationCredential.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ For security purposes, this cmdlet does not return credential passwords.
3434
## EXAMPLES
3535

3636
### Example 1: Get all credentials
37-
```
38-
PS C:\>Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
37+
```powershell
38+
Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
3939
```
4040

4141
This command gets metadata for all credentials in the Automation account named Contoso17.
4242

4343
### Example 2: Get a credential
44-
```
45-
PS C:\>Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoCredential"
44+
```powershell
45+
Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoCredential"
4646
```
4747

4848
This command gets metadata for the credential named ContosoCredential in the Automation account named Contoso17.

src/Automation/Automation/help/Get-AzAutomationDscCompilationJob.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ The **Get-AzAutomationDscCompilationJob** cmdlet gets APS Desired State Configur
3939
## EXAMPLES
4040

4141
### Example 1: Get all DSC compilation jobs
42-
```
43-
PS C:\>Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"
42+
```powershell
43+
Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"
4444
```
4545

4646
This command gets all compilation jobs in the Automation account named Contoso17.
4747

4848
### Example 2: Get DSC compilation jobs for a configuration
49-
```
50-
PS C:\>Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration"
49+
```powershell
50+
Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration"
5151
```
5252

5353
This command gets all compilation jobs for the DSC configuration named ContosoConfiguration in the Automation account named Contoso17.
5454

5555
### Example 3: Get a specific DSC compilation job
56-
```
57-
PS C:\>Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298
56+
```powershell
57+
Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298
5858
```
5959

6060
This command gets the compilation job with the specified ID in the Automation account named Contoso17.

src/Automation/Automation/help/Get-AzAutomationDscCompilationJobOutput.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The **Get-AzAutomationDscCompilationJobOutput** cmdlet gets the stream records o
2525
## EXAMPLES
2626

2727
### Example 1: Get the logs for a DSC compilation job
28-
```
29-
PS C:\>$Jobs = Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
30-
PS C:\> $Jobs[0] | Get-AzAutomationDscCompilationJobOutput -Stream "Any"
28+
```powershell
29+
$Jobs = Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"
30+
$Jobs[0] | Get-AzAutomationDscCompilationJobOutput -Stream "Any"
3131
```
3232

3333
The first command gets the compilation jobs in the Automation account named Contoso17 by using the Get-AzAutomationDscCompilationJob cmdlet.

src/Automation/Automation/help/Get-AzAutomationDscConfiguration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ The **Get-AzAutomationDscConfiguration** cmdlet gets APS Desired State Configura
3131
## EXAMPLES
3232

3333
### Example 1: Get all DSC configurations
34-
```
35-
PS C:\>Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"
34+
```powershell
35+
Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"
3636
```
3737

3838
This command gets metadata for all DSC configurations in the Automation account named Contoso17.
3939

4040
### Example 2: Get a DSC configuration by name
41-
```
42-
PS C:\>Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration"
41+
```powershell
42+
Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration"
4343
```
4444

4545
This command gets metadata for a DSC configuration named MyConfiguration in the Automation account named Contoso17.

0 commit comments

Comments
 (0)