New in version 2.7.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| ad_user | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
| adfs_authority_url (added in 2.6) | Default: None | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
| api_profile (added in 2.5) | Default: latest | 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. |
| auth_source (added in 2.5) |
| Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.When set to cli, the credentials will be sources from the default Azure CLI profile.Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.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. |
| cert_validation_mode (added in 2.5) |
| 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. |
| client_id | Azure client ID. Use when authenticating with a Service Principal. | |
| cloud_environment (added in 2.4) | Default: AzureCloud | 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. |
| name | Only show results for a specific web app. | |
| password | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
| profile | Security profile found in ~/.azure/credentials file. | |
| resource_group | Limit results by resource group. | |
| return_publish_profile bool |
| Indicate wheather to return publishing profile of the web app. |
| secret | Azure client secret. Use when authenticating with a Service Principal. | |
| subscription_id | Your Azure subscription Id. | |
| tags | Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
| tenant | Azure tenant ID. Use when authenticating with a Service Principal. |
Note
- name: Get facts for web app by name
azure_rm_webapp_facts:
resource_group: testrg
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_facts:
resource_group: testrg
- name: Get facts for web apps with tags
azure_rm_webapp_facts:
tags:
- testtag
- foo:bar
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| webapps complex | always | List of web apps. | |
| outbound_ip_addresses str | Outbound ip address of the web app. | ||
| resource_group str | always | Resource group of the web app. | |
| default_host_name str | Host name of the web app. | ||
| host_names list | Host names of the web app. | ||
| host_name_ssl_states list | SSL state per host names of the web app. | ||
| plan str | always | Id of app service plan used by the web app. Sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/serverfarms/xxx | |
| id str | always | Id of the web app. Sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/sites/xx | |
| name str | always | Name of the web app. | |
| frameworks complex | Frameworks of the application. Only returned when web app has frameworks. | ||
| enabled bool | Indicates the web app enabled or not. | ||
| availability_state str | Availability of this web app. | ||
| state str | State of the web app. eg. running. | ||
| publishing_username str | only when return_publish_profile is True. | Publishing profle user name. | |
| app_settings complex | App settings of the application. Only returned when web app has app settings. | ||
| publishing_password str | only when return_publish_profile is True. | Publishing profile password. | |
| enabled_host_names list | Enabled host names of the web app. | ||
| location str | always | Location of the web app. | |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_webapp_facts_module.html