azurerm_compute_image#

Azure Resource Manager (ARM) Compute Image Execution Module

New in version 2.1.0.

maintainer:

<devops@eitr.tech>

configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function in order to work properly.

Required provider parameters:

if using username and password:

  • subscription_id

  • username

  • password

if using a service principal:

  • subscription_id

  • tenant

  • client_id

  • secret

if using managed identity:

  • subscription_id

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.

Possible values: * AZURE_PUBLIC_CLOUD (default) * AZURE_CHINA_CLOUD * AZURE_US_GOV_CLOUD * AZURE_GERMAN_CLOUD

saltext.azurerm.modules.azurerm_compute_image.create_or_update(name, resource_group, source_vm=None, source_vm_group=None, os_disk=None, data_disks=None, zone_resilient=False, hyper_vgeneration=None, **kwargs)[source]#

New in version 2.1.0.

Create or update an image.

Parameters:

  • name – The image to create.

  • resource_group – The resource group name assigned to the image.

  • source_vm – The name of the virtual machine from which the image is created. This parameter or a valid os_disk is required.

  • source_vm_group – The name of the resource group containing the source virtual machine. This defaults to the same resource group specified for the resultant image.

  • os_disk – The resource ID of an operating system disk to use for the image.

  • data_disks – The resource ID or list of resource IDs associated with data disks to add to the image.

  • zone_resilient – Specifies whether an image is zone resilient or not. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

  • hyper_vgeneration – Gets the HyperVGenerationType of the VirtualMachine created from the image. Possible values include: “V1” and “V2”.

CLI Example:

salt-call azurerm_compute_image.create_or_update testimage testgroup
saltext.azurerm.modules.azurerm_compute_image.delete(name, resource_group, **kwargs)[source]#

New in version 2.1.0.

Delete an image.

Parameters:

  • name – The image to delete.

  • resource_group – The resource group name assigned to the image.

CLI Example:

salt-call azurerm_compute_image.delete testimage testgroup
saltext.azurerm.modules.azurerm_compute_image.get(name, resource_group, **kwargs)[source]#

New in version 2.1.0.

Get properties of the specified image.

Parameters:

  • name – The name of the image to query.

  • resource_group – The resource group name assigned to the image.

CLI Example:

salt-call azurerm_compute_image.get testimage testgroup
saltext.azurerm.modules.azurerm_compute_image.list_(resource_group=None, **kwargs)[source]#

New in version 2.1.0.

Gets the list of Images in the subscription.

Parameters:

resource_group – The name of the resource group to limit the results.

CLI Example:

salt-call azurerm_compute_image.list