azure.azcollection.azure_rm_automationrunbook module – Mange automation runbook

Note

This module is part of the azure.azcollection collection (version 1.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_automationrunbook.

New in azure.azcollection 1.12.0

Synopsis

  • Create, update, delete or publish automation runbook.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

automation_account_name

string / required

The name of the automation account.

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

description

string

Sets the description.

location

string

The location of the automation runbook.

log_activity_trace

integer

Sets the option to log activity trace of the runbook.

log_mode

string

Parent argument.

log_path

string

Parent argument.

log_progress

boolean

Sets progress log option.

Choices:

  • false

  • true

log_verbose

boolean

Sets verbose log option.

Choices:

  • false

  • true

name

string / required

The name of the automation runbook.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

publish

boolean

Whether to publish the runbook.

Choices:

  • false

  • true

resource_group

string / required

The name of the resource group.

runbook_type

string

Sets the type of the runbook.

Choices:

  • "Script"

  • "Graph"

  • "PowerShellWorkflow"

  • "PowerShell"

  • "GraphPowerShellWorkflow"

  • "GraphPowerShell"

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

State of the automation runbook. Use present to create or update a automation runbook and use absent to delete.

Choices:

  • "present" ← (default)

  • "absent"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: create automation runbook with default parameters
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    runbook_type: "Script"
    description: "Fred test"

- name: create automation runbook with more parameters
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    runbook_type: "Script"
    description: "Fred test"
    log_activity_trace: 3
    log_progress: True
    log_verbose: False
    tags:
      key1: value1

- name: Publish automation runbook
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    publish: True

- name: Delete automation runbook
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

state

complex

List of automation runbook dicts.

Returned: always

creation_time

string

The resource creation date time.

Returned: always

Sample: "2022-03-24T06:30:54.116666+00:00"

id

string

Resource ID.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/test/runbooks/runbook_name"

job_count

integer

The job count of the runbook.

Returned: always

Sample: 3

last_modified_by

string

The resource last modifier.

Returned: always

Sample: "Fred-sun"

last_modified_time

string

The last person to update the resource.

Returned: always

Sample: "2022-03-25T06:30:54.116666+00:00"

location

string

Resource location.

Returned: always

Sample: "eastus"

log_activity_trace

integer

The option to log activity trace of the runbook.

Returned: always

Sample: 3

log_progress

boolean

Whether show progress log option.

Returned: always

Sample: true

log_verbose

boolean

Whether show verbose log option.

Returned: always

Sample: true

name

string

Resource name.

Returned: always

Sample: "Testing"

output_types

list / elements=string

The runbook output type.

Returned: always

Sample: []

resource_group

string

Resource group name.

Returned: always

Sample: "myResourceGroup"

runbook_content_link

string

The publish runbook content link.

Returned: always

state

string

The resource state.

Returned: always

Sample: "Published"

tags

dictionary

The resource tags.

Returned: always

Sample: {"key1": "value1"}

type

string

The resource automation runbook type.

Returned: always

Sample: "Microsoft.Automation/AutomationAccounts/Runbooks"

Authors

  • Fred Sun (@Fred-sun)