New in version 2.1.
- python >= 2.7
- azure == 2.0.0rc5
parameter | required | default | choices | comments |
---|---|---|---|---|
ad_user |
no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
client_id |
no | Azure client ID. Use when authenticating with a Service Principal. | ||
location |
yes | Azure location value (ie. westus, eastus, eastus2, northcentralus, etc.). Supplying only a location value will yield a list of available publishers for the location. | ||
name |
no | Only show results for a specific security group. | ||
offer |
no | Name of an image offering. Combine with sku to see a list of available image versions. | ||
password |
no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
profile |
no | Security profile found in ~/.azure/credentials file. | ||
publisher |
no | Name of an image publisher. List image offerings associated with a particular publisher. | ||
secret |
no | Azure client secret. Use when authenticating with a Service Principal. | ||
sku |
no | Image offering SKU. Combine with offer to see a list of available versions. | ||
subscription_id |
no | Your Azure subscription Id. | ||
tenant |
no | Azure tenant ID. Use when authenticating with a Service Principal. | ||
version |
no | Specific version number of an image. |
- name: Get facts for a specific image azure_rm_virtualmachineimage_facts: location: eastus publisher: OpenLogic offer: CentOS sku: '7.1' version: '7.1.20160308' - name: List available versions azure_rm_virtualmachineimage_facts: location: eastus publisher: OpenLogic offer: CentOS sku: '7.1' - name: List available offers azure_rm_virtualmachineimage_facts: location: eastus publisher: OpenLogic - name: List available publishers azure_rm_virtualmachineimage_facts: location: eastus
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
azure_vmimages | List of image dicts. | always | list |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is supported mainly by the community and is curated by core committers.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.