community / community.azure / 1.0.0 / module / azure_rm_webapp_info Get Azure web app facts Authors: Yunge Zhu (@yungezz) preview | supported by communitycommunity.azure.azure_rm_webapp_info (1.0.0) — module
Install with ansible-galaxy collection install community.azure:==1.0.0
collections: - name: community.azure version: 1.0.0
Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.
- name: Get facts for web app by name community.azure.azure_rm_webapp_info: resource_group: myResourceGroup name: winwebapp1
- name: Get facts for web apps in resource group community.azure.azure_rm_webapp_info: resource_group: myResourceGroup
- name: Get facts for web apps with tags community.azure.azure_rm_webapp_info: tags: - testtag - foo:bar
name: description: - Only show results for a specific web app. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Limit results by resource group. subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection return_publish_profile: default: false description: - Indicate whether to return publishing profile of the web app. type: bool
webapps: contains: app_settings: description: - App settings of the application. Only returned when web app has app settings. returned: always sample: testkey: testvalue testkey2: testvalue2 type: dict availability_state: description: - Availability of this web app. returned: always sample: Normal type: str default_host_name: description: - Host name of the web app. returned: always sample: vxxisurg397winapp4.azurewebsites.net type: str enabled: description: - Indicates the web app enabled or not. returned: always sample: true type: bool enabled_host_names: description: - Enabled host names of the web app. returned: always sample: - vxxisurg397winapp4.azurewebsites.net - vxxisurg397winapp4.scm.azurewebsites.net type: list frameworks: description: - Frameworks of the application. Only returned when web app has frameworks. returned: always 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' type: list ftp_publish_url: description: - Publishing URL of the web app when deployment type is FTP. returned: always sample: ftp://xxxx.ftp.azurewebsites.windows.net type: str host_name_ssl_states: description: - SSL state per host names of the web app. returned: always sample: - hostType: Standard name: vxxisurg397winapp4.azurewebsites.net sslState: Disabled - hostType: Repository name: vxxisurg397winapp4.scm.azurewebsites.net sslState: Disabled type: list host_names: description: - Host names of the web app. returned: always sample: - vxxisurg397winapp4.azurewebsites.net type: list id: description: - ID of the web app. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp type: str location: description: - Location of the web app. returned: always sample: eastus type: str name: description: - Name of the web app. returned: always sample: winwebapp1 type: str outbound_ip_addresses: description: - Outbound IP address of the web app. returned: always sample: 40.71.11.131,40.85.166.200,168.62.166.67,137.135.126.248,137.135.121.45 type: str plan: description: - ID of app service plan used by the web app. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myAppServicePlan type: str publishing_password: description: - Publishing profile password. returned: only when I(return_publish_profile=True). sample: uvANsPQpGjWJmrFfm4Ssd5rpBSqGhjMk11pMSgW2vCsQtNx9tcgZ0xN26s9A type: str publishing_username: description: - Publishing profile user name. returned: only when I(return_publish_profile=True). sample: $vxxisuRG397winapp4 type: str resource_group: description: - Resource group of the web app. returned: always sample: myResourceGroup type: str state: description: - State of the web app. returned: always sample: running type: str tags: description: - Tags assigned to the resource. Dictionary of string:string pairs. returned: always sample: tag1: abc type: dict description: - List of web apps. returned: always type: complex