exec.azurerm.web.app

Azure Resource Manager (ARM) Web App Operations Execution Module

New in version 3.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.web.app.create_or_update(hub, ctx, name, resource_group, kind=None, server_farm_id=None, **kwargs)

New in version 3.0.0.

Create function for web site, or a deployment slot.

Parameters:
  • name – Unique name of the app to create or update.
  • resource_group – The name of the resource group.
  • kind – The kind of the App. Possible values include: “app”, “functionapp”
  • server_farm_id – Resource ID of the associated App Service Plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”

CLI Example:

azurerm.web.app.create_or_update test_name test_site test_group
idem_azurerm.exec.azurerm.web.app.delete(hub, ctx, name, resource_group, delete_metrics=None, delete_empty_server_farm=None, **kwargs)

New in version 3.0.0.

Deletes a web, mobile, or API app, or one of the deployment slots.

Parameters:
  • name – The name of the App to delete.
  • resource_group – The name of the resource group.
  • delete_metrics – If true, web app metrics are also deleted.
  • delete_empty_server_farm – Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.

CLI Example:

azurerm.web.app.delete test_name test_group
idem_azurerm.exec.azurerm.web.app.get(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the details of a web, mobile, or API app.

Parameters:
  • name – The name of the App.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.get test_name test_group
idem_azurerm.exec.azurerm.web.app.get_app_settings_key_vault_references(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the config reference app settings and status of an app.

Parameters:
  • name – The name of the App.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.get_app_settings_key_vault_references test_name test_group
idem_azurerm.exec.azurerm.web.app.get_configuration(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.

Parameters:
  • name – The name of the App.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.get_configuration test_name test_group
idem_azurerm.exec.azurerm.web.app.get_function(hub, ctx, name, site, resource_group, **kwargs)

New in version 3.0.0.

Get function information by its ID for web site, or a deployment slot.

Parameters:
  • name – The name of the function.
  • site – The name of the site.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.get_function test_name test_site test_group
idem_azurerm.exec.azurerm.web.app.list_(hub, ctx, resource_group=None, **kwargs)

New in version 3.0.0.

Get all apps for a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.web.app.list
idem_azurerm.exec.azurerm.web.app.list_application_settings(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the application settings of an app.

Parameters:
  • name – The name of the app.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.list_application_settings test_name test_group
idem_azurerm.exec.azurerm.web.app.list_publishing_credentials(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the Git/FTP publishing credentials of an app.

Parameters:
  • name – The name of the function.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.web.app.list_publishing_credentials test_name test_group