azure_rm_webapp_facts – Get azure web app facts.
azure_rm_webapp_facts – Get azure web app facts.
New in version 2.7.
Synopsis
- Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.
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 - |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url - added in 2.6 |
Default: null |
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 |
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
When set to Can also be set via the When set to The |
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 |
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, |
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 boolean |
|
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. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.
Examples
- 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
Return Values
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.
| |
app_settings complex |
App settings of the application. Only returned when web app has app settings.
| ||
availability_state string |
Availability of this web app.
| ||
default_host_name string |
Host name of the web app.
| ||
enabled boolean |
Indicates the web app enabled or not.
| ||
enabled_host_names list |
Enabled host names of the web app.
| ||
frameworks complex |
Frameworks of the application. Only returned when web app has frameworks.
| ||
host_name_ssl_states list |
SSL state per host names of the web app.
| ||
host_names list |
Host names of the web app.
| ||
id string |
always |
Id of the web app.
Sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/sites/xx | |
location string |
always |
Location of the web app.
| |
name string |
always |
Name of the web app.
| |
outbound_ip_addresses string |
Outbound ip address of the web app.
| ||
plan string |
always |
Id of app service plan used by the web app.
Sample: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/serverfarms/xxx | |
publishing_password string |
only when return_publish_profile is True. |
Publishing profile password.
| |
publishing_username string |
only when return_publish_profile is True. |
Publishing profle user name.
| |
resource_group string |
always |
Resource group of the web app.
| |
state string |
State of the web app. eg. running.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Yunge Zhu (@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2019 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