azure_rm_appserviceplan_facts – Get azure app service plan facts.

From Get docs
Ansible/docs/2.7/modules/azure rm appserviceplan facts module


azure_rm_appserviceplan_facts – Get azure app service plan facts.

New in version 2.7.


Synopsis

  • Get facts for a specific app service plan or all app service plans in a resource group, or all app service plan in current subscription.

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 latest is appropriate for public clouds; future values will allow use with Azure Stack.

auth_source

-

added in 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

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

-

added in 2.5

  • validate
  • ignore

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

-

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, 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.

name

-

Only show results for a specific app service plan.

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

-

Limit results by resource group.

secret

-

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

-

Your Azure subscription Id.

tags

-

Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.

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: Get facts for app service plan by name
  azure_rm_appserviceplan_facts:
    resource_group: testrg
    name: winwebapp1

- name: Get azure_rm_appserviceplan_facts for app service plan in resource group
  azure_rm_webapp_facts:
    resource_group: testrg

- name: Get facts for app service plan with tags
  azure_rm_appserviceplan_facts:
    tags:
      - testtag
      - foo:bar

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

appserviceplans

complex

always

List of app service plans.


id

string

always

Id of the app service plan.


Sample:

/subscriptions/xxxx/resourceGroupsxxx/providers/Microsoft.Web/serverfarms/xxx

kind

string

always

Kind of the app service plan.


Sample:

app

location

string

always

Location of the app service plan.


name

string

always

Name of the app service plan.


resource_group

string

always

Resource group of the app service plan.


sku

complex

always

Sku of the app service plan.


capacity

integer

always

Capacity of sku.


Sample:

1

family

string

always

Family of sku.


Sample:

S

name

string

always

Name of sku.


Sample:

S1

size

string

always

Size of sku.


Sample:

S1

tier

string

always

Tier of sku.


Sample:

Standard




Status

Authors

  • Yunge Zhu (@yungezz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 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_facts_module.html