azure_rm_appserviceplan – Manage App Service Plan¶
New in version 2.7.
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
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. |
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. |
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
string
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
|
profile
string
|
Security profile found in ~/.azure/credentials file.
|
|
resource_group
-
/ required
|
Name of the resource group to which the resource belongs.
|
|
secret
string
|
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
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.
|
Notes¶
Note
- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
. - Authentication is also 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.
See Also¶
See also
- Sign in with Azure CLI
- How to authenticate using the
az login
command.
Examples¶
- name: Create a windows app service plan
azure_rm_appserviceplan:
resource_group: myResourceGroup
name: myAppPlan
location: eastus
sku: S1
- name: Create a linux app service plan
azure_rm_appserviceplan:
resource_group: myResourceGroup
name: myAppPlan
location: eastus
sku: S1
is_linux: true
number_of_workers: 1
- name: update sku of existing windows app service plan
azure_rm_appserviceplan:
resource_group: myResourceGroup
name: myAppPlan
location: eastus
sku: S2
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.