Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_webapp_info
.
New in version 0.1.2: of azure.azcollection
The below requirements are needed on the host that executes this module.
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 latest is appropriate for public clouds; future values will allow use with Azure Stack. |
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 ANSIBLE_AZURE_AUTH_SOURCE environment variable.When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli .When set to env , the credentials will be read from the environment variablesWhen set to credential_file , it will read the profile from ~/.azure/credentials .When set to cli , the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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 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 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 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, 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. |
log_mode string | Parent argument. | |
log_path string | Parent argument. | |
name string | 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 string | Limit results by resource group. | |
return_publish_profile boolean |
| 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 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. |
Note
az login
.See also
How to authenticate using the az login
command.
- 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
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 / elements=string | always | Enabled host names of the web app. Sample: ['vxxisurg397winapp4.azurewebsites.net', 'vxxisurg397winapp4.scm.azurewebsites.net'] | |
frameworks list / elements=string | 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 / elements=string | 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 / elements=string | 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'} |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_webapp_info_module.html