azure.azcollection.azure_rm_vmsku_info module – Get compute-related SKUs list
Note
This module is part of the azure.azcollection collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_vmsku_info
.
New in azure.azcollection 2.4.0
Synopsis
Get details for compute-related resource SKUs.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
A region supported by current subscription. |
|
Parent argument. |
|
Parent argument. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Resource types e.g. “availabilitySets”, “snapshots”, “disks”, etc. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Size name, partial name is accepted. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
|
Show skus supporting availability zones. Choices:
|
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: Gather Resource Group info
azure.azcollection.azure_rm_resourcegroup_info:
name: "{{ resource_group }}"
register: rg_info
- name: List available VM SKUs
azure.azcollection.azure_rm_vmsku_info:
location: "{{ rg_info.resourcegroups.0.location }}"
resource_type: "virtualMachines"
size: "standard_B1"
zone: true
register: available_skus_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of compute-related resource SKUs. Returned: always |
|
A name value pair to describe the capability. Returned: always |
|
An invariant to describe the feature. Returned: always Sample: |
|
An invariant if the feature is measured by quantity. Returned: always Sample: |
|
The Family of this particular SKU. Returned: always Sample: |
|
A list of locations and availability zones in those locations where the SKU is available. Returned: always |
|
Location of the SKU. Returned: always Sample: |
|
Details of capabilities available to a SKU in specific zones. Returned: always |
|
A list of capabilities that are available for the SKU in the specified list of zones. Returned: always |
|
An invariant to describe the feature. Returned: always Sample: |
|
An invariant if the feature is measured by quantity. Returned: always Sample: |
|
List of availability zones where the SKU is supported. Returned: always Sample: |
|
The set of locations that the SKU is available. Returned: always Sample: |
|
The name of SKU. Returned: always Sample: |
|
The type of resource the SKU applies to. Returned: always Sample: |
|
The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. Returned: always |
|
The reason for restriction. Returned: success Sample: |
|
The information about the restriction where the SKU cannot be used. Returned: always |
|
Locations where the SKU is restricted. Returned: success Sample: |
|
List of availability zones where the SKU is restricted. Returned: success Sample: |
|
The type of restrictions. Returned: always Sample: |
|
The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. Returned: always Sample: |
|
The Size of the SKU. Returned: always Sample: |
|
Specifies the tier of virtual machines in a scale set. Returned: always Sample: |
Authors
Nir Argaman (@nirarg)