ansible / ansible.builtin / v2.9.17 / module / azure_rm_image Manage Azure image | "added in version" 2.5 of ansible.builtin" Authors: Yuwei Zhou (@yuwzho) preview | supported by communityansible.builtin.azure_rm_image (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, delete an image from virtual machine, blob uri, managed disk or snapshot.
- name: Create an image from a virtual machine azure_rm_image: resource_group: myResourceGroup name: myImage source: myVirtualMachine
- name: Create an image from os disk azure_rm_image: resource_group: myResourceGroup name: myImage source: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/disks/disk001 data_disk_sources: - datadisk001 - datadisk002 os_type: Linux
- name: Create an image from os disk via dict azure_rm_image: resource_group: myResourceGroup name: myImage source: type: disks resource_group: myResourceGroup name: disk001 data_disk_sources: - datadisk001 - datadisk002 os_type: Linux
- name: Delete an image azure_rm_image: state: absent resource_group: myResourceGroup name: myImage source: testvm001
name: description: - Name of the image. required: true tags: description: - 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. type: dict state: choices: - absent - present default: present description: - Assert the state of the image. Use C(present) to create or update a image and C(absent) to delete an image. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str source: description: - OS disk source from the same region. - It can be a virtual machine, OS disk blob URI, managed OS disk, or OS snapshot. - Each type of source except for blob URI can be given as resource id, name or a dict contains C(resource_group), C(name) and C(type). - If source type is blob URI, the source should be the full URI of the blob in string type. - If you specify the I(type) in a dict, acceptable value contains C(disks), C(virtual_machines) and C(snapshots). required: true type: raw 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 os_type: choices: - Windows - Linux description: The OS type of image. profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Location of the image. Derived from I(resource_group) if not specified. 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: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - 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: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Name of resource group. required: true 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: 0.0.1 version_added_collection: azure.azcollection data_disk_sources: description: - List of data disk sources, including unmanaged blob URI, managed disk id or name, or snapshot id or name. type: list adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 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: 0.0.1 version_added_collection: azure.azcollection
id: description: - Image resource path. example: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/images/myImage returned: success type: str