Partager via

Start-AzureRMAutomationRunbook

  • Référence
Module:
AzureRM.Automation

Démarre un travail de runbook.

Avertissement

Le module AzureRM PowerShell a été officiellement déprécié le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Il est possible que le module AzureRM fonctionne encore, mais il ne fait plus l’objet de maintenance ni de support. L’utilisateur peut continuer à s’en servir s’il le souhaite, à ses propres risques. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

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

Description

L’applet de commande Start-AzureRmAutomationRunbook 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

PS C:\>Start-AzureRmAutomationRunbook -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 et attendre les résultats

Start-AzureRmAutomationRunbook -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

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

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

Type:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

Type:String
Alias:RunbookName
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Parameters

Type:IDictionary
Alias:JobParameters
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceGroupName

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-RunOn

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

Type:String
Alias:HybridWorker
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Sorties

Job

-Cette applet de commande retourne un objet Job , sauf si vous spécifiez le paramètre Wait . -Si vous ne spécifiez pas Wait, Azure PowerShell retourne immédiatement un objet Job . -Si vous spécifiez Wait, Azure PowerShell termine le travail, puis retourne le résultat. -Le résultat n’est pas un objet Job .

PSObject