community.azure.azure_rm_automationaccount_facts – Get Azure automation account facts
community.azure.azure_rm_automationaccount_facts – Get Azure automation account facts
Note
This plugin is part of the community.azure collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_automationaccount_facts
.
Synopsis
- Get facts of automation account.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
Parameter | Choices/Defaults | 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 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
auth_source string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
list_keys boolean |
|
List keys for a automation account. Note this will cost network overhead, suggest only used when name set. |
list_statistics boolean |
|
List statistics details for a automation account. Note this will cost network overhead, suggest only used when name set. |
list_usages boolean |
|
List usage details for a automation account. Note this will cost network overhead, suggest only used when name set. |
name string |
The name of the automation account. | |
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. | |
resource_group string / required |
The name of the resource group. | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags list / elements=string |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
Azure tenant ID. 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
Examples
- name: Get details of an automation account
community.azure.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
community.azure.azure_rm_automationaccount_info:
resource_group: myResourceGroup
- name: List automation account in a resource group
community.azure.azure_rm_automationaccount_info:
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
automation_accounts complex |
always |
List of automation account dicts.
| |||
creation_time string |
always |
Resource creation date time.
Sample: 2019-04-26T02:55:16.500Z | |||
id string |
always |
Resource ID.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing | |||
keys complex |
always |
Resource keys.
| |||
key_name string |
always |
Name of the key.
Sample: Primary | |||
permissions string |
always |
Permission of the key.
Sample: Full | |||
value string |
always |
Value of the key.
Sample: MbepKTO6IyGwml0GaKBkKN | |||
last_modified_time string |
always |
Resource last modified date time.
Sample: 2019-04-26T02:55:16.500Z | |||
location string |
always |
Resource location.
Sample: eastus | |||
name string |
always |
Resource name.
Sample: Testing | |||
resource_group string |
always |
Resource group name.
Sample: myResourceGroup | |||
state string |
always |
Resource state.
Sample: ok | |||
statistics complex |
always |
Resource statistics.
| |||
counter_property string |
always |
Property value of the statistic.
Sample: New | |||
counter_value integer |
always |
Value of the statistic.
| |||
end_time string |
always |
EndTime of the statistic.
Sample: 2019-04-26T06:29:43.587518Z | |||
id string |
always |
ID of the statistic.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing/statistics/New | |||
start_time string |
always |
StartTime of the statistic.
Sample: 2019-04-26T06:29:43.587518Z | |||
usages complex |
always |
Resource usages.
| |||
current_value float |
always |
Current usage.
| |||
limit integer |
always |
Max limit,
Sample: -1 | |||
name complex |
always |
Usage counter name.
| |||
localized_value string |
always |
Localized name.
Sample: SubscriptionUsage | |||
value string |
always |
Name value.
Sample: SubscriptionUsage | |||
throttle_status string |
always |
Usage throttle status.
Sample: NotThrottled | |||
unit string |
always |
Usage unit name.
Sample: Minute |
Authors
- Yuwei Zhou (@yuwzho)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_automationaccount_facts_module.html