Get-AzureRMAutomationRunbook.md

external help file	Module Name	ms.assetid	online version	schema
Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml	AzureRM.Automation	EDB918EA-4FF3-44EF-A4CA-5BFBD14340EA	https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationrunbook	2.0.0

Get-AzureRmAutomationRunbook

SYNOPSIS

Gets a runbook.

SYNTAX

ByAll (Default)

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

ByRunbookName

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

DESCRIPTION

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

EXAMPLES

Example 1: Get all runbooks

PS C:\>Get-AzureRmAutomationRunbook -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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of a runbook that this cmdlet gets.

Type: System.String
Parameter Sets: ByRunbookName
Aliases: RunbookName

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Automation.Model.Runbook

NOTES

RELATED LINKS

Export-AzureRmAutomationRunbook

Import-AzureRmAutomationRunbook

New-AzureRmAutomationRunbook

New-AzureRmAutomationRunbook

Publish-AzureRmAutomationRunbook

Remove-AzureRmAutomationRunbook

Set-AzureRmAutomationRunbook

Start-AzureRmAutomationRunbook