Partage via

az automation runbook

  • Expérimental
  • Référence

Remarque

Cette référence fait partie de l’extension Automation pour Azure CLI (version 2.55.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande runbook az automation. En savoir plus sur les extensions.

Ce groupe de commandes est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Runbook Automation.

Commandes

Nom Description Type État
az automation runbook create

Créez le runbook identifié par le nom du runbook.

 Extension Expérimental
az automation runbook delete

Supprimez le runbook par nom.

 Extension Expérimental
az automation runbook list

Récupérez une liste de runbooks.

 Extension Expérimental
az automation runbook publish

Publier un brouillon de runbook.

 Extension Expérimental
az automation runbook replace-content

Remplacez le contenu du runbook.

 Extension Expérimental
az automation runbook revert-to-published

Rétablissez le contenu du runbook à l’état publié connu.

 Extension Expérimental
az automation runbook show

Récupérez le runbook identifié par le nom du runbook.

 Extension Expérimental
az automation runbook start

Démarrer le runbook.

 Extension Expérimental
az automation runbook update

Mettez à jour le runbook identifié par le nom du runbook.

 Extension Expérimental
az automation runbook wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition du runbook Automation soit remplie.

 Extension Expérimental

az automation runbook create

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez le runbook identifié par le nom du runbook.

az automation runbook create --automation-account-name
                             --name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script}
                             [--description]
                             [--location]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

Exemples

Créer un runbook

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

Paramètres obligatoires

--automation-account-name

Nom du compte Automation.

--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--type

Type du runbook.

Valeurs acceptées: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Paramètres facultatifs

--description

Description du runbook.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--log-activity-trace

Options de suivi au niveau de l’activité du runbook.

--log-progress

Option de journal de progression du runbook.

Valeurs acceptées: false, true
--log-verbose

Option de journal détaillée du runbook.

Valeurs acceptées: false, true
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook delete

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez le runbook par nom.

az automation runbook delete [--automation-account-name]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Exemples

Supprimer un runbook

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--yes -y

Ne pas demander de confirmation.

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook list

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Récupérez une liste de runbooks.

az automation runbook list --automation-account-name
                           --resource-group

Exemples

Répertorier les runbooks par compte Automation

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

Paramètres obligatoires

--automation-account-name

Nom du compte Automation.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook publish

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Publier un brouillon de runbook.

az automation runbook publish [--automation-account-name]
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]

Exemples

Publier un brouillon de runbook

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Paramètres fournis à l’opération de runbook de publication.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook replace-content

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Remplacez le contenu du runbook.

az automation runbook replace-content --content
                                      [--automation-account-name]
                                      [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]

Exemples

Remplacer le contenu du runbook

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

Paramètres obligatoires

--content

Contenu du runbook.

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Nom du runbook.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook revert-to-published

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Rétablissez le contenu du runbook à l’état publié connu.

az automation runbook revert-to-published [--automation-account-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Exemples

Remplacer le contenu du runbook

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook show

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Récupérez le runbook identifié par le nom du runbook.

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Exemples

Obtenir un runbook

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook start

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Démarrer le runbook.

az automation runbook start [--automation-account-name]
                            [--ids]
                            [--name]
                            [--parameters]
                            [--resource-group]
                            [--run-on]
                            [--subscription]

Exemples

Démarrer le runbook

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --runbook-name -n

Nom du runbook.

--parameters

Paramètres du travail. Valeur attendue : KEY1=VALUE1 KEY2=VALUE2...

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--run-on

RunOn qui spécifie le nom du groupe dans lequel le travail doit être exécuté.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook update

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour le runbook identifié par le nom du runbook.

az automation runbook update [--automation-account-name]
                             [--description]
                             [--ids]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

Exemples

Mettre à jour un runbook

az automation runbook update --automation-account-name "myAutomationAccount" --description                "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false                --resource-group "rg" --runbook-name "myRunbook"

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--description

Description du runbook.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--log-activity-trace

Options de suivi au niveau de l’activité du runbook.

--log-progress

Option de journal de progression du runbook.

Valeurs acceptées: false, true
--log-verbose

Option de journal détaillée du runbook.

Valeurs acceptées: false, true
--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation runbook wait

Expérimental

Le groupe de commandes « runbook automation » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition du runbook Automation soit remplie.

az automation runbook wait [--automation-account-name]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que le runbook Automation soit correctement créé.

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

Paramètres facultatifs

--automation-account-name

Nom du compte Automation.

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

Valeur par défaut: False
--exists

Attendez que la ressource existe.

Valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

Valeur par défaut: 30
--name --runbook-name -n

Nom du runbook.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--timeout

Délai maximal d’attente en secondes.

Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.