exec.azurerm.web.app_service_plan

Azure Resource Manager (ARM) Web App Service Plan 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_service_plan.create_or_update(hub, ctx, name, resource_group, kind, sku='F1', reserved=None, tags=None, **kwargs)

New in version 3.0.0.

Creates or updates an App Service Plan.

Parameters:
  • name – The name of the App Service Plan.
  • resource_group – The name of the resource group.
  • kind – The kind of the App Service Plan. Possible values include: “linux”, “windows”, “functionapp”
  • sku – The SKU (pricing tier) of the App Service Plan. Defaults to “F1”.
  • reserved – This value should be True if you are using a Linux App Service Plan, False otherwise. Defaults to False.
  • tags – Tags associated with the App Service Plan.

CLI Example:

azurerm.web.app_service_plan.create_or_update test_name test_group test_kind test_sku
idem_azurerm.exec.azurerm.web.app_service_plan.delete(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Delete an App Service Plan.

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

CLI Example:

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

New in version 3.0.0.

Get an App Service plan.

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

CLI Example:

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

New in version 3.0.0.

Gets all selectable SKUs for a given App Service Plan.

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

CLI Example:

azurerm.web.app_service_plan.get_server_farm_skus test_name test_group
idem_azurerm.exec.azurerm.web.app_service_plan.list_(hub, ctx, resource_group=None, detailed=None, **kwargs)

New in version 3.0.0.

Get all App Service plans for a subscription.

Parameters:
  • resource_group – The name of the resource group to limit the results.
  • detailed – Specify True to return all App Service Plan properties. The default is False, which returns a subset of the properties. Retrieval of all properties may increase the API latency. If a resource group is specified, then all App Service Plan properties are returned regardless of what this parameter is set to.

CLI Example:

azurerm.web.app_service_plan.list
idem_azurerm.exec.azurerm.web.app_service_plan.list_web_apps(hub, ctx, name, resource_group, skip_token=None, **kwargs)

New in version 3.0.0.

Get all apps associated with an App Service plan.

Parameters:
  • name – The name of the App Service Plan.
  • resource_group – The name of the resource group.
  • skip_token – Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list.

CLI Example:

azurerm.web.app_service_plan.list_web_apps test_name test_group