Partager via


Start-AzAutomationRunbook

Démarre un travail de runbook.

Syntaxe

ByAsynchronousReturnJob (Par défaut)

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

BySynchronousReturnJobOutput

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

Description

L’applet de commande Start-AzAutomationRunbook démarre une tâche de runbook Azure Automation. Spécifiez l’ID ou le nom d’un runbook.

Exemples

Exemple 1 : Démarrer un travail de runbook

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

Cette commande démarre un travail de runbook pour le runbook nommé Runbk01 dans le compte Azure Automation nommé Contoso17.

Exemple 2 : Démarrer un travail de runbook Python 2 avec des paramètres

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

Cette commande démarre un travail de runbook pour le runbook Python 2 nommé RunbkPy01 dans le compte Azure Automation nommé Contoso17 avec « ValueForPosition1 » comme premier paramètre positionnel et « ValueForPosition2 » pour le deuxième.

Exemple 3 : Démarrer un travail de runbook et attendre les résultats

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

Cette commande démarre un travail de runbook pour le runbook nommé Runbk01 dans le compte Azure Automation nommé Contoso17. Cette commande spécifie le paramètre Wait . Par conséquent, il retourne les résultats une fois le travail terminé. L’applet de commande attend jusqu’à 1 000 secondes pour les résultats.

Paramètres

-AutomationAccountName

L’applet de commande Start-AzAutomationRunbook démarre une tâche de runbook Azure Automation. Spécifiez l’ID ou le nom d’un runbook.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-MaxWaitSeconds

Spécifie le nombre de secondes pendant lesquelles cette applet de commande attend la fin d’un travail avant d’abandonner le travail. La valeur par défaut est 10800 ou trois heures.

Propriétés du paramètre

Type:Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

BySynchronousReturnJobOutput
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

L’applet de commande Start-AzAutomationRunbook démarre une tâche de runbook Azure Automation. Spécifiez l’ID ou le nom d’un runbook.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:RunbookName

Jeux de paramètres

(All)
Position:2
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Parameters

L’applet de commande Start-AzAutomationRunbook démarre une tâche de runbook Azure Automation. Spécifiez l’ID ou le nom d’un runbook.

Propriétés du paramètre

Type:IDictionary
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:JobParameters

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ResourceGroupName

L’applet de commande Start-AzAutomationRunbook démarre une tâche de runbook Azure Automation. Spécifiez l’ID ou le nom d’un runbook.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-RunOn

Spécifie le groupe worker hybride sur lequel exécuter le runbook.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:HybridWorker

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Wait

Indique que cette applet de commande attend la fin, la suspension ou l’échec du travail, puis retourne le contrôle à Azure PowerShell.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

BySynchronousReturnJobOutput
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

String

Sorties

Job

PSObject