community.azure.azure_rm_appserviceplan_facts (0.1.0) — module

Get azure app service plan facts

Authors: Yunge Zhu (@yungezz)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.azure:==0.1.0


Add to requirements.yml

  collections:
    - name: community.azure
      version: 0.1.0

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get facts for app service plan by name
      azure_rm_appserviceplan_info:
        resource_group: myResourceGroup
        name: myAppServicePlan
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get azure_rm_appserviceplan_facts for app service plan in resource group
      azure_rm_appserviceplan_info:
        resource_group: myResourceGroup
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Get facts for app service plan with tags
      azure_rm_appserviceplan_info:
        tags:
          - testtag
          - foo:bar

Inputs

    
name:
    description:
    - Only show results for a specific app service plan.

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

secret:
    description:
    - Azure client secret. Use when authenticating with a Service Principal.
    type: str

tenant:
    description:
    - Azure tenant ID. Use when authenticating with a Service Principal.
    type: str

ad_user:
    description:
    - Active Directory username. Use when authenticating with an Active Directory user
      rather than service principal.
    type: str

profile:
    description:
    - Security profile found in ~/.azure/credentials file.
    type: str

password:
    description:
    - Active Directory user password. Use when authenticating with an Active Directory
      user rather than service principal.
    type: str

client_id:
    description:
    - Azure client ID. Use when authenticating with a Service Principal.
    type: str

api_profile:
    default: latest
    description:
    - Selects an API profile to use when communicating with Azure services. Default value
      of C(latest) is appropriate for public clouds; future values will allow use with
      Azure Stack.
    type: str
    version_added: '2.5'
    version_added_collection: azure.azcollection

auth_source:
    choices:
    - auto
    - cli
    - credential_file
    - env
    - msi
    description:
    - 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 C(auto) if variable is not defined.
    - C(auto) will follow the default precedence of module parameters -> environment variables
      -> default profile in credential file C(~/.azure/credentials).
    - When set to C(cli), the credentials will be sources from the default Azure CLI profile.
    - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
    - When set to C(msi), the host machine must be an azure resource with an enabled MSI
      extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
    type: str
    version_added: '2.5'
    version_added_collection: azure.azcollection

resource_group:
    description:
    - Limit results by resource group.

subscription_id:
    description:
    - Your Azure subscription Id.
    type: str

cloud_environment:
    default: AzureCloud
    description:
    - For cloud environments other than the US public cloud, the environment name (as
      defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
      metadata discovery endpoint URL (required for Azure Stack). Can also be set via
      credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
    type: str
    version_added: '2.4'
    version_added_collection: azure.azcollection

adfs_authority_url:
    description:
    - Azure AD authority url. Use when authenticating with Username/password, and has
      your own ADFS authority.
    type: str
    version_added: '2.6'
    version_added_collection: azure.azcollection

cert_validation_mode:
    choices:
    - ignore
    - validate
    description:
    - 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
      C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
      environment variable.
    type: str
    version_added: '2.5'
    version_added_collection: azure.azcollection

Outputs

appserviceplans:
  contains:
    id:
      description: Id of the app service plan.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myPlan
      type: str
    kind:
      description: Kind of the app service plan.
      returned: always
      sample: app
      type: str
    location:
      description: Location of the app service plan.
      returned: always
      type: str
    name:
      description: Name of the app service plan.
      returned: always
      type: str
    resource_group:
      description: Resource group of the app service plan.
      returned: always
      sample: myResourceGroup
      type: str
    sku:
      contains:
        capacity:
          description: Capacity of sku.
          returned: always
          sample: 1
          type: int
        family:
          description: Family of sku.
          returned: always
          sample: S
          type: str
        name:
          description: Name of sku.
          returned: always
          sample: S1
          type: str
        size:
          description: Size of sku.
          returned: always
          sample: S1
          type: str
        tier:
          description: Tier of sku.
          returned: always
          sample: Standard
          type: str
      description: Sku of the app service plan.
      returned: always
      type: complex
  description: List of app service plans.
  returned: always
  type: complex

See also