Try SpotterGet azure web app facts.
| "added in version" 2.7 of ansible.builtin"
Authors: Yunge Zhu (@yungezz)
preview | supported by community
pipInstall with pip install ansible==2.8.19
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
azure_rm_webapp_facts:
resource_group: myResourceGroup
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_facts:
resource_group: myResourceGroup
- name: Get facts for web apps with tags
azure_rm_webapp_facts:
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.
type: complex
availability_state:
description: Availability of this web app.
type: str
default_host_name:
description: Host name of the web app.
type: str
enabled:
description: Indicates the web app enabled or not.
type: bool
enabled_host_names:
description: Enabled host names of the web app.
type: list
frameworks:
description:
- Frameworks of the application. Only returned when web app has frameworks.
type: complex
ftp_publish_url:
description: Publishing url of the web app when deployment type is FTP.
sample: ftp://xxxx.ftp.azurewebsites.windows.net
type: str
host_name_ssl_states:
description: SSL state per host names of the web app.
type: list
host_names:
description: Host names of the web app.
type: list
id:
description:
- Id of the web app.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/xx
type: str
location:
description:
- Location of the web app.
returned: always
type: str
name:
description:
- Name of the web app.
returned: always
type: str
outbound_ip_addresses:
description: Outbound ip address of the web app.
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/xxx
type: str
publishing_password:
description: Publishing profile password.
returned: only when I(return_publish_profile) is True.
type: str
publishing_username:
description: Publishing profile user name.
returned: only when I(return_publish_profile) is True.
type: str
resource_group:
description:
- Resource group of the web app.
returned: always
sample: myResourceGroup
type: str
state:
description: State of the web app. eg. running.
type: str
tags:
description: Tags assigned to the resource. Dictionary of string:string pairs.
sample:
tag1: abc
type: dict
description: List of web apps.
returned: always
type: complex