azure_rm_appserviceplan – Manage App Service Plan
azure_rm_appserviceplan – Manage App Service Plan
New in version 2.7.
Synopsis
- Create, update and delete instance of App Service Plan.
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 - |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url - added in 2.6 |
Default: null |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
api_profile - added in 2.5 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
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 - 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
When set to Can also be set via the When set to The |
cert_validation_mode - 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 |
client_id - |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment - 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, |
is_linux boolean |
|
Describe whether to host webapp on Linux worker. |
location - |
Resource location. If not set, location from the resource group will be used as default. | |
name - / required |
Unique name of the app service plan to create or update. | |
number_of_workers - |
Describe number of workers to be allocated. | |
password - |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile - |
Security profile found in ~/.azure/credentials file. | |
resource_group - / required |
Name of the resource group to which the resource belongs. | |
secret - |
Azure client secret. Use when authenticating with a Service Principal. | |
sku - |
The pricing tiers, e.g., F1, D1, B1, B2, B3, S1, P1, P1V2 etc. Please see https://azure.microsoft.com/en-us/pricing/details/app-service/plans/ for more detail. For linux app service plan, please see https://azure.microsoft.com/en-us/pricing/details/app-service/linux/ for more detail. | |
state - |
|
Assert the state of the app service plan. Use 'present' to create or update an app service plan and 'absent' to delete it. |
subscription_id - |
Your Azure subscription Id. | |
tags - |
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 - |
Azure tenant ID. Use when authenticating with a Service Principal. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.
Examples
- name: Create a windows app service plan
azure_rm_appserviceplan:
name: "windowsplan1"
resource_group: "appserviceplan_rg"
location: "eastus"
sku: S1
- name: Create a linux app service plan
azure_rm_appserviceplan:
resource_group: "appserviceplan_rg"
name: "linuxplan1"
location: "eastus"
sku: S1
is_linux: true
number_of_workers: 1
- name: update sku of existing windows app service plan
azure_rm_appserviceplan:
name: "windowsplan2"
resource_group: "appserviceplan_rg"
location: "eastus"
sku: S2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
azure_appserviceplan dictionary |
always |
Facts about the current state of the app service plan
Sample: {'id': '/subscriptions//resourceGroups/ansiblewebapp1_plan/providers/Microsoft.Web/serverfarms/win_appplan11'} |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Yunge Zhu(@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_appserviceplan_module.html