ansible / ansible.builtin / v2.9.7 / module / azure_rm_functionapp Manage Azure Function Apps | "added in version" 2.4 of ansible.builtin" Authors: Thomas Stringer (@trstringer) preview | supported by communityansible.builtin.azure_rm_functionapp (v2.9.7) — module
pip
Install with pip install ansible==2.9.7
Create, update or delete an Azure Function App.
- 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
name: description: - Name of the Azure Function App. required: true plan: description: - 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 C(name), C(resource_group). - C(name). Name of app service plan. - C(resource_group). Resource group name of app service plan. version_added: '2.8' version_added_collection: ansible.builtin tags: description: - 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. - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. - Azure Front Door doesn't support the use of - Azure Automation and Azure CDN only support 15 tags on resources. type: dict state: choices: - absent - present default: present description: - Assert the state of the Function App. Use C(present) to create or update a Function App and C(absent) to delete. 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 location: description: - Valid Azure location. Defaults to location of the resource group. 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 append_tags: default: true description: - 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. type: bool 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 app_settings: description: - Dictionary containing application settings. resource_group: aliases: - resource_group_name description: - Name of resource group. required: true storage_account: aliases: - storage - storage_account_name description: - Name of the storage account to use. required: true 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 container_settings: description: Web app container settings. suboptions: name: description: - Name of container. For example "imagename:tag". registry_server_password: description: - The container registry server password. registry_server_url: description: - Container registry server url. For example C(mydockerregistry.io). registry_server_user: description: - The container registry server user name. version_added: '2.8' version_added_collection: ansible.builtin 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
state: description: - Current state of the Azure Function App. 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/EastUSPlan state: Running type: Microsoft.Web/sites usage_state: Normal returned: success type: dict