exec.azurerm.compute.virtual_machine_extension

Azure Resource Manager (ARM) Compute Virtual Machine Extension Operations Execution Module

New in version 2.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct 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

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
idem_azurerm.exec.azurerm.compute.virtual_machine_extension.create_or_update(hub, ctx, name, vm_name, resource_group, location, publisher, extension_type, version, settings, auto_upgrade_minor_version=None, **kwargs)

New in version 2.0.0.

The operation to create or update the extension.

Parameters:
  • name – The name of the virtual machine extension.
  • vm_name – The name of the virtual machine where the extension should be created or updated.
  • resource_group – The name of the resource group.
  • location – Resource location.
  • publisher – The publisher of the extension.
  • extension_type – Specifies the type of the extension; an example is “CustomScriptExtension”.
  • version – Specifies the version of the script handler.
  • settings – A dictionary representing the public settings for the extension. This dictionary will be utilized as JSON by the SDK operation.
  • auto_upgrade_minor_version – A boolean value indicating whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to True.
  • tags – A dictionary of strings can be passed as tag metadata to the virtual machine extension object.

CLI Example:

azurerm.compute.virtual_machine_extension.create_or_update test_name test_vm test_group test_loc test_publisher
                                                           test_type test_version test_settings
idem_azurerm.exec.azurerm.compute.virtual_machine_extension.delete(hub, ctx, name, vm_name, resource_group, **kwargs)

New in version 2.0.0.

The operation to delete the extension.

Parameters:
  • name – The name of the virtual machine extension.
  • vm_name – The name of the virtual machine where the extension should be deleted.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.compute.virtual_machine_extension.delete test_name test_vm test_group
idem_azurerm.exec.azurerm.compute.virtual_machine_extension.get(hub, ctx, name, vm_name, resource_group, **kwargs)

New in version 2.0.0.

The operation to get the extension.

Parameters:
  • name – The name of the virtual machine extension.
  • vm_name – The name of the virtual machine containing the extension.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.compute.virtual_machine_extension.get test_name test_vm test_group
idem_azurerm.exec.azurerm.compute.virtual_machine_extension.list_(hub, ctx, vm_name, resource_group, **kwargs)

New in version 2.0.0.

The operation to get all extensions of a Virtual Machine.

Parameters:
  • vm_name – The name of the virtual machine containing the extension.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.compute.virtual_machine_extension.list test_vm test_group