azure_rm_webapp_info – Get Azure web app facts¶

New in version 2.9.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis ¶

Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.

Aliases: azure_rm_webapp_facts

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 2.6		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string 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 string added in 2.5	Choices: auto cli credential_file env msi	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 string added in 2.5	Choices: ignore validate	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 string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string 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 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 -		Limit results by resource group.
return_publish_profile boolean	Choices: no ← yes	Indicate whether to return publishing profile of the web app.
secret string		Azure client secret. Use when authenticating with a Service Principal.
subscription_id string		Your Azure subscription Id.
tags -		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.

Examples ¶

- name: Get facts for web app by name
  azure_rm_webapp_info:
    resource_group: myResourceGroup
    name: winwebapp1

- name: Get facts for web apps in resource group
  azure_rm_webapp_info:
    resource_group: myResourceGroup

- name: Get facts for web apps with tags
  azure_rm_webapp_info:
    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 dictionary	always	App settings of the application. Only returned when web app has app settings. Sample: {'testkey': 'testvalue', 'testkey2': 'testvalue2'}
	availability_state string	always	Availability of this web app. Sample: Normal
	default_host_name string	always	Host name of the web app. Sample: vxxisurg397winapp4.azurewebsites.net
	enabled boolean	always	Indicates the web app enabled or not. Sample: True
	enabled_host_names list	always	Enabled host names of the web app. Sample: ['vxxisurg397winapp4.azurewebsites.net', 'vxxisurg397winapp4.scm.azurewebsites.net']
	frameworks list	always	Frameworks of the application. Only returned when web app has frameworks. Sample: [{'name': 'net_framework', 'version': 'v4.0'}, {'name': 'java', 'settings': {'java_container': 'tomcat', 'java_container_version': '8.5'}, 'version': '1.7'}, {'name': 'php', 'version': '5.6'}]
	ftp_publish_url string	always	Publishing URL of the web app when deployment type is FTP. Sample: ftp://xxxx.ftp.azurewebsites.windows.net
	host_name_ssl_states list	always	SSL state per host names of the web app. Sample: [{'hostType': 'Standard', 'name': 'vxxisurg397winapp4.azurewebsites.net', 'sslState': 'Disabled'}, {'hostType': 'Repository', 'name': 'vxxisurg397winapp4.scm.azurewebsites.net', 'sslState': 'Disabled'}]
	host_names list	always	Host names of the web app. Sample: ['vxxisurg397winapp4.azurewebsites.net']
	id string	always	ID of the web app. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp
	location string	always	Location of the web app. Sample: eastus
	name string	always	Name of the web app. Sample: winwebapp1
	outbound_ip_addresses string	always	Outbound IP address of the web app. Sample: 40.71.11.131,40.85.166.200,168.62.166.67,137.135.126.248,137.135.121.45
	plan string	always	ID of app service plan used by the web app. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myAppServicePlan
	publishing_password string	only when return_publish_profile=True.	Publishing profile password. Sample: uvANsPQpGjWJmrFfm4Ssd5rpBSqGhjMk11pMSgW2vCsQtNx9tcgZ0xN26s9A
	publishing_username string	only when return_publish_profile=True.	Publishing profile user name. Sample: $vxxisuRG397winapp4
	resource_group string	always	Resource group of the web app. Sample: myResourceGroup
	state string	always	State of the web app. Sample: running
	tags dictionary	always	Tags assigned to the resource. Dictionary of string:string pairs. Sample: {'tag1': 'abc'}

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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.