Поделиться через

Start-AzAutomationRunbook

  • Ссылка
Модуль:
Az.Automation

Запускает задание Runbook.

Синтаксис

Start-AzAutomationRunbook
     [-Name] <String>
     [-Parameters <IDictionary>]
     [-RunOn <String>]
     [-ResourceGroupName] <String>
     [-AutomationAccountName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]
Start-AzAutomationRunbook
     [-Name] <String>
     [-Parameters <IDictionary>]
     [-RunOn <String>]
     [-Wait]
     [-MaxWaitSeconds <Int32>]
     [-ResourceGroupName] <String>
     [-AutomationAccountName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Описание

Командлет Start-AzAutomationRunbook запускает задание runbook служба автоматизации Azure. Укажите идентификатор или имя модуля Runbook.

Примеры

Пример 1. Запуск задания Runbook

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

Эта команда запускает задание Runbook для модуля Runbook с именем Runbk01 в учетной записи служба автоматизации Azure с именем Contoso17.

Пример 2. Запуск задания Runbook Python 2 с параметрами

$params = [ordered]@{"Key1"="ValueForPosition1";"Key2"="ValueForPosition2"}
Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "RunbkPy01" -ResourceGroupName "ResourceGroup01" -Parameters $params

Эта команда запускает задание Runbook для модуля Runbook Python 2 с именем RunbkPy01 в учетной записи служба автоматизации Azure с именем Contoso17 со значением ValueForPosition1 в качестве первого позиционного параметра и ValueForPosition2 для второго.

Пример 3. Запуск задания Runbook и ожидание результатов

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -MaxWaitSeconds 1000 -Wait

Эта команда запускает задание Runbook для модуля Runbook с именем Runbk01 в учетной записи служба автоматизации Azure с именем Contoso17. Эта команда задает параметр Wait . Поэтому он возвращает результаты после завершения задания. Командлет ожидает до 1000 секунд.

Параметры

-AutomationAccountName

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

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

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

-MaxWaitSeconds

Указывает количество секунд, которое этот командлет ожидает завершения задания, прежде чем он откажется от задания. Значение по умолчанию — 10800 или три часа.

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

-Name

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

-Parameters

Type:IDictionary
Aliases:JobParameters
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

-RunOn

Указывает, какая группа гибридных рабочих ролей, в которой выполняется модуль Runbook.

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

-Wait

Указывает, что этот командлет ожидает завершения, приостановки или сбоя задания, а затем возвращает управление в Azure PowerShell.

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

Входные данные

String

Выходные данные

Job

PSObject