Get-AzAutomationRunbook

  • Reference
Module:
Az.Automation

Gets a runbook.

Syntax

Get-AzAutomationRunbook
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationRunbook
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzAutomationRunbook cmdlet gets Azure Automation runbooks. To get a specific runbook, specify its name.

Examples

Example 1: Get all runbooks

Get-AzAutomationRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01"

This command gets all runbooks in the Azure Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of an Automation account in which this cmdlet gets runbooks.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a runbook that this cmdlet gets.

Type:String
Aliases:RunbookName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group for which this cmdlet gets runbooks.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

Runbook