az automation runbook

  • Habilitación de características
  • Referencia

Nota:

Esta referencia forma parte de la extensión de automatización para la CLI de Azure (versión 2.55.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az automation runbook . Obtenga más información sobre las extensiones.

Este grupo de comandos es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Runbook de Automation.

Comandos

Nombre Description Tipo Estado
az automation runbook create

Cree el runbook identificado por el nombre del runbook.

 Extensión Habilitación de características
az automation runbook delete

Elimine el runbook por nombre.

 Extensión Habilitación de características
az automation runbook list

Recuperar una lista de runbooks.

 Extensión Habilitación de características
az automation runbook publish

Publicar borrador de runbook.

 Extensión Habilitación de características
az automation runbook replace-content

Reemplace el contenido del runbook.

 Extensión Habilitación de características
az automation runbook revert-to-published

Revierta el contenido del runbook al último estado publicado conocido.

 Extensión Habilitación de características
az automation runbook show

Recupere el runbook identificado por el nombre del runbook.

 Extensión Habilitación de características
az automation runbook start

Inicie el runbook.

 Extensión Habilitación de características
az automation runbook update

Actualice el runbook identificado por el nombre del runbook.

 Extensión Habilitación de características
az automation runbook wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del runbook de automation.

 Extensión Habilitación de características

az automation runbook create

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree el runbook identificado por el nombre del 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]

Ejemplos

Crear un runbook

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

Parámetros requeridos

--automation-account-name

Nombre de la cuenta de Automation.

--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--type

Tipo del runbook.

valores aceptados: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Parámetros opcionales

--description

Descripción del runbook.

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--log-activity-trace

Opciones de seguimiento de nivel de actividad del runbook.

--log-progress

Opción de registro de progreso del runbook.

valores aceptados: false, true
--log-verbose

Opción de registro detallado del runbook.

valores aceptados: false, true
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook delete

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine el runbook por nombre.

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

Ejemplos

Eliminación de un runbook

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook list

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Recuperar una lista de runbooks.

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

Ejemplos

Enumeración de runbooks por cuenta de Automation

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

Parámetros requeridos

--automation-account-name

Nombre de la cuenta de Automation.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook publish

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Publicar borrador de runbook.

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

Ejemplos

Publicar borrador de runbook

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Parámetros proporcionados a la operación de publicación del runbook.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook replace-content

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Reemplace el contenido del runbook.

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

Ejemplos

Reemplazar el contenido del runbook

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

Parámetros requeridos

--content

Contenido del runbook.

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Nombre del runbook.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook revert-to-published

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Revierta el contenido del runbook al último estado publicado conocido.

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

Ejemplos

Reemplazar el contenido del runbook

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook show

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Recupere el runbook identificado por el nombre del runbook.

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

Ejemplos

Obtener runbook

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook start

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Inicie el runbook.

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

Ejemplos

Inicio del runbook

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name --runbook-name -n

Nombre del runbook.

--parameters

Parámetros del trabajo. Valor esperado: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--run-on

RunOn que especifica el nombre del grupo donde se va a ejecutar el trabajo.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook update

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualice el runbook identificado por el nombre del 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]

Ejemplos

Actualizar 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"

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--description

Descripción del runbook.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--log-activity-trace

Opciones de seguimiento de nivel de actividad del runbook.

--log-progress

Opción de registro de progreso del runbook.

valores aceptados: false, true
--log-verbose

Opción de registro detallado del runbook.

valores aceptados: false, true
--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az automation runbook wait

Habilitación de características

El grupo de comandos "runbook de automatización" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Coloque la CLI en un estado de espera hasta que se cumpla una condición del runbook de automation.

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

Ejemplos

Pause la ejecución de la siguiente línea de script de la CLI hasta que el runbook de automation se cree correctamente.

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

Parámetros opcionales

--automation-account-name

Nombre de la cuenta de Automation.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--name --runbook-name -n

Nombre del runbook.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.