community.azure.azure_rm_functionapp_facts (0.1.0) — module

Get Azure Function App facts

Authors: Thomas Stringer (@trstringer)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.azure:==0.1.0


Add to requirements.yml

  collections:
    - name: community.azure
      version: 0.1.0

Description

Get facts for one Azure Function App or all Function Apps within a resource group.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get facts for one Function App
      azure_rm_functionapp_info:
        resource_group: myResourceGroup
        name: myfunctionapp
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get facts for all Function Apps in a resource group
      azure_rm_functionapp_info:
        resource_group: myResourceGroup
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get facts for all Function Apps by tags
      azure_rm_functionapp_info:
        tags:
          - testing

Inputs

    
name:
    description:
    - Only show results for a specific Function 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

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

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: '2.5'
    version_added_collection: azure.azcollection

auth_source:
    choices:
    - auto
    - cli
    - credential_file
    - env
    - msi
    description:
    - 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 C(auto) if variable is not defined.
    - C(auto) will follow the default precedence of module parameters -> environment variables
      -> default profile in credential file C(~/.azure/credentials).
    - When set to C(cli), the credentials will be sources from the default Azure CLI profile.
    - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
    - 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: '2.5'
    version_added_collection: azure.azcollection

resource_group:
    aliases:
    - resource_group_name
    description:
    - Limit results to a resource group. Required when filtering by name.

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: '2.4'
    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: '2.6'
    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: '2.5'
    version_added_collection: azure.azcollection

Outputs

azure_functionapps:
  description:
  - List of Azure Function Apps dicts.
  example:
    availability_state: Normal
    client_affinity_enabled: true
    client_cert_enabled: false
    container_size: 1536
    daily_memory_time_quota: 0
    default_host_name: myfunctionapp.azurewebsites.net
    enabled: true
    enabled_host_names:
    - myfunctionapp.azurewebsites.net
    - myfunctionapp.scm.azurewebsites.net
    host_name_ssl_states:
    - host_type: Standard
      name: myfunctionapp.azurewebsites.net
      ssl_state: Disabled
    - host_type: Repository
      name: myfunctionapp.scm.azurewebsites.net
      ssl_state: Disabled
    host_names:
    - myfunctionapp.azurewebsites.net
    host_names_disabled: false
    id: /subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/sites/myfunctionapp
    kind: functionapp
    last_modified_time_utc: '2017-08-22T18:54:01.190000+00:00'
    location: East US
    name: myfunctionapp
    outbound_ip_addresses: '............'
    repository_site_name: myfunctionapp
    reserved: false
    resource_group: myResourceGroup
    scm_site_also_stopped: false
    server_farm_id: /subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/serverfarms/EastUSPlan
    state: Running
    type: Microsoft.Web/sites
    usage_state: Normal
  returned: always
  type: list

See also