azurerm_compute_virtual_machine_image#

Azure Resource Manager (ARM) Compute Virtual Machine 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_virtual_machine_image.get(location, publisher, offer, sku, version, **kwargs)[source]#

New in version 2.1.0.

Gets a virtual machine image.

Parameters:

  • location – The name of a supported Azure region.

  • publisher – A valid image publisher.

  • offer – A valid image publisher offer.

  • sku – A valid image SKU.

  • version – A valid image SKU version.

CLI Example:

salt-call azurerm_compute_virtual_machine_image.get "eastus" test_publisher test_offer test_sku test_version
saltext.azurerm.modules.azurerm_compute_virtual_machine_image.list_(location, publisher, offer, sku, **kwargs)[source]#

New in version 2.1.0.

Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

Parameters:

  • location – The name of a supported Azure region.

  • publisher – A valid image publisher.

  • offer – A valid image publisher offer.

  • sku – A valid image SKU.

CLI Example:

salt-call azurerm_compute_virtual_machine_image.list "eastus" test_publisher test_offer test_sku
saltext.azurerm.modules.azurerm_compute_virtual_machine_image.list_offers(location, publisher, **kwargs)[source]#

New in version 2.1.0.

Gets a list of virtual machine image offers for the specified location and publisher.

Parameters:

  • location – The name of a supported Azure region.

  • publisher – A valid image publisher.

CLI Example:

salt-call azurerm_compute_virtual_machine_image.list_offers "eastus" test_publisher
saltext.azurerm.modules.azurerm_compute_virtual_machine_image.list_publishers(location, **kwargs)[source]#

New in version 2.1.0.

Gets a list of virtual machine image publishers for the specified Azure location.

Parameters:

location – The name of a supported Azure region.

CLI Example:

salt-call azurerm_compute_virtual_machine_image.list_publishers "eastus"
saltext.azurerm.modules.azurerm_compute_virtual_machine_image.list_skus(location, publisher, offer, **kwargs)[source]#

New in version 2.1.0.

Gets a list of virtual machine image offers for the specified location and publisher.

Parameters:

  • location – The name of a supported Azure region.

  • publisher – A valid image publisher.

  • offer – A valid image publisher offer.

CLI Example:

salt-call azurerm_compute_virtual_machine_image.list_skus "eastus" test_publisher test_offer