Try SpotterGet Azure automation account facts
| "added in version" 2.9 of ansible.builtin"
Authors: Yuwei Zhou (@yuwzho)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Get facts of automation account.
- name: Get details of an automation account
azure_rm_automationaccount_info:
name: Testing
resource_group: myResourceGroup
list_statistics: yes
list_usages: yes
list_keys: yes
- name: List automation account in a resource group
azure_rm_automationaccount_info:
resource_group: myResourceGroup
- name: List automation account in a resource group azure_rm_automationaccount_info:
name:
description:
- The name of the automation account.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
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
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.
type: str
list_keys:
description:
- List keys for a automation account.
- Note this will cost network overhead, suggest only used when I(name) set.
type: bool
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
list_usages:
description:
- List usage details for a automation account.
- Note this will cost network overhead, suggest only used when I(name) set.
type: bool
resource_group:
description:
- The name of the resource group.
required: true
type: str
list_statistics:
description:
- List statistics details for a automation account.
- Note this will cost network overhead, suggest only used when I(name) set.
type: bool
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
automation_accounts:
contains:
creation_time:
description:
- Resource creation date time.
returned: always
sample: '2019-04-26T02:55:16.500Z'
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing
type: str
keys:
contains:
key_name:
description:
- Name of the key.
returned: always
sample: Primary
type: str
permissions:
description:
- Permission of the key.
returned: always
sample: Full
type: str
value:
description:
- Value of the key.
returned: always
sample: MbepKTO6IyGwml0GaKBkKN
type: str
description:
- Resource keys.
returned: always
type: complex
last_modified_time:
description:
- Resource last modified date time.
returned: always
sample: '2019-04-26T02:55:16.500Z'
type: str
location:
description:
- Resource location.
returned: always
sample: eastus
type: str
name:
description:
- Resource name.
returned: always
sample: Testing
type: str
resource_group:
description:
- Resource group name.
returned: always
sample: myResourceGroup
type: str
state:
description:
- Resource state.
returned: always
sample: ok
type: str
statistics:
contains:
counter_property:
description:
- Property value of the statistic.
returned: always
sample: New
type: str
counter_value:
description:
- Value of the statistic.
returned: always
sample: 0
type: int
end_time:
description:
- EndTime of the statistic.
returned: always
sample: '2019-04-26T06:29:43.587518Z'
type: str
id:
description:
- ID of the statistic.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups
/myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing/statistics/New
type: str
start_time:
description:
- StartTime of the statistic.
returned: always
sample: '2019-04-26T06:29:43.587518Z'
type: str
description:
- Resource statistics.
returned: always
type: complex
usages:
contains:
current_value:
description:
- Current usage.
returned: always
sample: 0.0
type: float
limit:
description:
- Max limit, C(-1) for unlimited.
returned: always
sample: -1
type: int
name:
contains:
localized_value:
description:
- Localized name.
returned: always
sample: SubscriptionUsage
type: str
value:
description:
- Name value.
returned: always
sample: SubscriptionUsage
type: str
description:
- Usage counter name.
returned: always
type: complex
throttle_status:
description:
- Usage throttle status.
returned: always
sample: NotThrottled
type: str
unit:
description:
- Usage unit name.
returned: always
sample: Minute
type: str
description:
- Resource usages.
returned: always
type: complex
description:
- List of automation account dicts.
returned: always
type: complex