W3cubDocs

/Ansible 2.10

azure.azcollection.azure_rm_functionapp – Manage Azure Function Apps

Note

This plugin is part of the azure.azcollection collection.

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_functionapp.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update or delete an Azure Function App.

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 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.
app_settings
string
Dictionary containing application settings.
append_tags
boolean
    Choices:
  • no
  • yes ←
Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
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 variables
When 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
    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 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.
container_settings
string
Web app container settings.
name
string
Name of container. For example "imagename:tag".
registry_server_password
string
The container registry server password.
registry_server_url
string
Container registry server url. For example mydockerregistry.io.
registry_server_user
string
The container registry server user name.
location
string
Valid Azure location. Defaults to location of the resource group.
name
string / required
Name of the Azure Function App.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
plan
string
App service plan.
It can be name of existing app service plan in same resource group as function app.
It can be resource id of existing app service plan.
Resource id. For example /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>.
It can be a dict which contains name, resource_group.
name. Name of app service plan.
resource_group. Resource group name of app service plan.
profile
string
Security profile found in ~/.azure/credentials file.
resource_group
string / required
Name of resource group.

aliases: resource_group_name
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the Function App. Use present to create or update a Function App and absent to delete.
storage_account
string / required
Name of the storage account to use.

aliases: storage, storage_account_name
subscription_id
string
Your Azure subscription Id.
tags
dictionary
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
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.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create a function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount

- name: Create a function app with app settings
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount
    app_settings:
      setting1: value1
      setting2: value2

- name: Create container based function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount
    plan:
      resource_group: myResourceGroup
      name: myAppPlan
    container_settings:
      name: httpd
      registry_server_url: index.docker.io

- name: Delete a function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
state
dictionary
success
Current state of the Azure Function App.

Sample:
{'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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myFunctionApp', 'kind': 'functionapp', 'last_modified_time_utc': '2017-08-22T18:54:01.190Z', '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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/EastUSPlan', 'state': 'Running', 'type': 'Microsoft.Web/sites', 'usage_state': 'Normal'}


Authors

  • Thomas Stringer (@trstringer)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_functionapp_module.html