New in version 2.4.
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 2.6 | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | ||
| api_profile string added in 2.5 | 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 - | Dictionary containing application settings. | ||
| append_tags boolean |
| 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 2.5 |
| 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 auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.When set to cli, the credentials will be sources from the default Azure CLI profile.Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.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 2.5 |
| 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 2.4 | 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 - added in 2.8 | Web app container settings. | ||
| name - | Name of container. For example "imagename:tag". | ||
| registry_server_password - | The container registry server password. | ||
| registry_server_url - | Container registry server url. For example mydockerregistry.io. | ||
| registry_server_user - | The container registry server user name. | ||
| location - | Valid Azure location. Defaults to location of the resource group. | ||
| name - / 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 - added in 2.8 | 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 - / required | Name of resource group. aliases: resource_group_name | ||
| secret string | Azure client secret. Use when authenticating with a Service Principal. | ||
| state - |
| Assert the state of the Function App. Use present to create or update a Function App and absent to delete. | |
| storage_account - / 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. | ||
Note
az login.See also
az login command.- 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
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. |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_functionapp_module.html