az automation runbook
Nota
Essa referência faz parte da extensão de automação para a CLI do Azure (versão 2.55.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az automation runbook . Saiba mais sobre extensões.
Este grupo de comando é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Runbook de automação.
Comandos
Name | Description | Tipo | Estado |
---|---|---|---|
az automation runbook create |
Crie o runbook identificado pelo nome do runbook. |
Extensão | Experimental |
az automation runbook delete |
Exclua o runbook pelo nome. |
Extensão | Experimental |
az automation runbook list |
Recupere uma lista de runbooks. |
Extensão | Experimental |
az automation runbook publish |
Publicar rascunho de runbook. |
Extensão | Experimental |
az automation runbook replace-content |
Substitua o conteúdo do runbook. |
Extensão | Experimental |
az automation runbook revert-to-published |
Reverta o conteúdo do runbook para o último estado publicado conhecido. |
Extensão | Experimental |
az automation runbook show |
Recupere o runbook identificado pelo nome do runbook. |
Extensão | Experimental |
az automation runbook start |
Inicie o runbook. |
Extensão | Experimental |
az automation runbook update |
Atualize o runbook identificado pelo nome do runbook. |
Extensão | Experimental |
az automation runbook wait |
Coloque a CLI em um estado de espera até que uma condição do runbook de automação seja atendida. |
Extensão | Experimental |
az automation runbook create
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Crie o runbook identificado pelo nome do 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]
Exemplos
Criar um runbook
az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --type "PowerShell" --location "East US 2"
Parâmetros Obrigatórios
O nome da conta de automação.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Tipo de runbook.
Parâmetros Opcionais
Descrição do runbook.
Localização. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
Opções de rastreamento de nível de atividade do runbook.
Opção de log de progresso do runbook.
Opção de log detalhado do runbook.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook delete
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Exclua o runbook pelo nome.
az automation runbook delete [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Excluir um runbook
az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Não solicite confirmação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook list
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Recupere uma lista de runbooks.
az automation runbook list --automation-account-name
--resource-group
Exemplos
Listar runbooks por conta de automação
az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"
Parâmetros Obrigatórios
O nome da conta de automação.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook publish
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Publicar rascunho de runbook.
az automation runbook publish [--automation-account-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Exemplos
Publicar rascunho de runbook
az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
Os parâmetros fornecidos para a operação do runbook de publicação.
Não espere que a operação de longa duração termine.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook replace-content
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Substitua o conteúdo do runbook.
az automation runbook replace-content --content
[--automation-account-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Exemplos
Substituir o conteúdo do runbook
az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --content @/path/to/script
Parâmetros Obrigatórios
O conteúdo do runbook.
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do runbook.
Não espere que a operação de longa duração termine.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook revert-to-published
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Reverta o conteúdo do runbook para o último estado publicado conhecido.
az automation runbook revert-to-published [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Substituir o conteúdo do runbook
az automation runbook revert-to-published --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook show
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Recupere o runbook identificado pelo nome do runbook.
az automation runbook show [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Obter runbook
az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook start
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Inicie o runbook.
az automation runbook start [--automation-account-name]
[--ids]
[--name]
[--parameters]
[--resource-group]
[--run-on]
[--subscription]
Exemplos
Iniciar o runbook
az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Parâmetros Opcionais
O nome da conta de automação.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do runbook.
Parâmetros do trabalho. Valor esperado: KEY1=VALUE1 KEY2=VALUE2 ...
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
RunOn que especifica o nome do grupo onde o trabalho deve ser executado.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook update
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Atualize o runbook identificado pelo nome do 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]
Exemplos
Atualizar um 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"
Parâmetros Opcionais
O nome da conta de automação.
Descrição do runbook.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
Opções de rastreamento de nível de atividade do runbook.
Opção de log de progresso do runbook.
Opção de log detalhado do runbook.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az automation runbook wait
O grupo de comando 'automation runbook' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Coloque a CLI em um estado de espera até que uma condição do runbook de automação seja atendida.
az automation runbook wait [--automation-account-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Exemplos
Pause a execução da próxima linha do script CLI até que o runbook de automação seja criado com êxito.
az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --created
Parâmetros Opcionais
O nome da conta de automação.
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
Intervalo de sondagem em segundos.
O nome do runbook.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Espera máxima em segundos.
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.