Try SpotterGet Azure automation runbook facts
| "added in version" 1.12.0 of azure.azcollection"
Authors: Fred Sun (@Fred-sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts of automation runbook.
- name: Get details of an automation account
azure_rm_automationrunbook_info:
resource_group: "{{ resource_group }}"
automation_account_name: "{{ account-name }}"
name: "{{ runbook-name }}"
- name: List automation runbook in the account
azure_rm_automationrunbook_info:
resource_group: "{{ resource_group }}"
automation_account_name: "{{ account-name }}"
- name: Get details of an automation account
azure_rm_automationrunbook_info:
resource_group: "{{ resource_group }}"
automation_account_name: "{{ account-name }}"
name: "{{ runbook-name }}"
show_content: true
name:
description:
- The name of the automation runbook.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
elements: str
type: list
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
show_content:
description:
- Wether retrieve the content of runbook identified by runbook name.
type: bool
resource_group:
description:
- The name of the resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
automation_account_name:
description:
- The name of the automation account.
required: true
type: str
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
automation_runbook:
contains:
creation_time:
description:
- The resource creation date time.
returned: always
sample: '2022-03-24T06:30:54.116666+00:00'
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/test/runbooks/runbook_name
type: str
job_count:
description:
- The job count of the runbook.
returned: always
sample: 3
type: int
last_modified_by:
description:
- The resource last modifier.
returned: always
sample: Fred-sun
type: str
last_modified_time:
description:
- The last person to update the resource.
returned: always
sample: '2022-03-25T06:30:54.116666+00:00'
type: str
location:
description:
- Resource location.
returned: always
sample: eastus
type: str
log_activity_trace:
description:
- The option to log activity trace of the runbook.
returned: always
sample: 3
type: int
log_progress:
description:
- Whether show progress log option.
returned: always
sample: true
type: bool
log_verbose:
description:
- Whether show verbose log option.
returned: always
sample: true
type: bool
name:
description:
- Resource name.
returned: always
sample: Testing
type: str
output_types:
description:
- The runbook output type.
returned: always
sample: []
type: list
resource_group:
description:
- Resource group name.
returned: always
sample: myResourceGroup
type: str
runbook_content_link:
description:
- The publish runbook content link.
returned: always
sample: null
type: str
state:
description:
- The resource state.
returned: always
sample: Published
type: str
tags:
description:
- The resource tags.
returned: always
sample:
key1: value1
type: list
type:
description:
- The resource automation runbook type.
returned: always
sample: Microsoft.Automation/AutomationAccounts/Runbooks
type: str
description:
- List of automation runbook dicts.
returned: always
type: complex