virtual_machine_extensions

Creates, updates, deletes, gets or lists a virtual_machine_extensions resource.

Overview

Name	virtual_machine_extensions
Type	Resource
Id	azure.compute.virtual_machine_extensions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoUpgradeMinorVersion	boolean	Indicates 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.
enableAutomaticUpgrade	boolean	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag	string	How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView	object	The virtual machine extension instance view.
location	string	The geo-location where the resource lives. Required.
protectedSettings	object	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault	object	The extensions protected settings that are passed by reference, and consumed from key vault.
provisionAfterExtensions	array	Collection of extension names after which this extension needs to be provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
publisher	string	The name of the extension handler publisher.
settings	object	Json formatted public settings for the extension.
suppressFailures	boolean	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeHandlerVersion	string	Specifies the version of the script handler.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoUpgradeMinorVersion	boolean	Indicates 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.
enableAutomaticUpgrade	boolean	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag	string	How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView	object	The virtual machine extension instance view.
location	string	The geo-location where the resource lives. Required.
protectedSettings	object	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault	object	The extensions protected settings that are passed by reference, and consumed from key vault.
provisionAfterExtensions	array	Collection of extension names after which this extension needs to be provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
publisher	string	The name of the extension handler publisher.
settings	object	Json formatted public settings for the extension.
suppressFailures	boolean	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeHandlerVersion	string	Specifies the version of the script handler.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vm_name, vm_extension_name, subscription_id	$expand	The operation to get the extension.
list	select	resource_group_name, vm_name, subscription_id	$expand	The operation to get all extensions of a Virtual Machine.
create_or_update	insert	resource_group_name, vm_name, vm_extension_name, subscription_id, location		The operation to create or update the extension.
update	update	resource_group_name, vm_name, vm_extension_name, subscription_id		The operation to update the extension.
create_or_update	replace	resource_group_name, vm_name, vm_extension_name, subscription_id, location		The operation to create or update the extension.
delete	delete	resource_group_name, vm_name, vm_extension_name, subscription_id		The operation to delete the extension.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vm_extension_name	string	The name of the virtual machine extension. Required.
vm_name	string	The name of the virtual machine. Required.
$expand	string	The expand expression to apply on the operation. Default value is None.

SELECT examples

get

The operation to get the extension.

SELECT
id,
name,
autoUpgradeMinorVersion,
enableAutomaticUpgrade,
forceUpdateTag,
instanceView,
location,
protectedSettings,
protectedSettingsFromKeyVault,
provisionAfterExtensions,
provisioningState,
publisher,
settings,
suppressFailures,
systemData,
tags,
type,
typeHandlerVersion
FROM azure.compute.virtual_machine_extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vm_name = '{{ vm_name }}' -- required
AND vm_extension_name = '{{ vm_extension_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

The operation to get all extensions of a Virtual Machine.

SELECT
id,
name,
autoUpgradeMinorVersion,
enableAutomaticUpgrade,
forceUpdateTag,
instanceView,
location,
protectedSettings,
protectedSettingsFromKeyVault,
provisionAfterExtensions,
provisioningState,
publisher,
settings,
suppressFailures,
systemData,
tags,
type,
typeHandlerVersion
FROM azure.compute.virtual_machine_extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vm_name = '{{ vm_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

The operation to create or update the extension.

INSERT INTO azure.compute.virtual_machine_extensions (
tags,
location,
properties,
resource_group_name,
vm_name,
vm_extension_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vm_name }}',
'{{ vm_extension_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machine_extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_machine_extensions resource.
  - name: vm_name
    value: "{{ vm_name }}"
    description: Required parameter for the virtual_machine_extensions resource.
  - name: vm_extension_name
    value: "{{ vm_extension_name }}"
    description: Required parameter for the virtual_machine_extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_machine_extensions resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the properties of a Virtual Machine Extension.
    value:
      forceUpdateTag: "{{ forceUpdateTag }}"
      publisher: "{{ publisher }}"
      type: "{{ type }}"
      typeHandlerVersion: "{{ typeHandlerVersion }}"
      autoUpgradeMinorVersion: {{ autoUpgradeMinorVersion }}
      enableAutomaticUpgrade: {{ enableAutomaticUpgrade }}
      settings: "{{ settings }}"
      protectedSettings: "{{ protectedSettings }}"
      provisioningState: "{{ provisioningState }}"
      instanceView:
        name: "{{ name }}"
        type: "{{ type }}"
        typeHandlerVersion: "{{ typeHandlerVersion }}"
        substatuses:
          - code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
        statuses:
          - code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      suppressFailures: {{ suppressFailures }}
      protectedSettingsFromKeyVault:
        secretUrl: "{{ secretUrl }}"
        sourceVault:
          id: "{{ id }}"
      provisionAfterExtensions:
        - "{{ provisionAfterExtensions }}"

UPDATE examples

update

The operation to update the extension.

UPDATE azure.compute.virtual_machine_extensions
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vm_name = '{{ vm_name }}' --required
AND vm_extension_name = '{{ vm_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

The operation to create or update the extension.

REPLACE azure.compute.virtual_machine_extensions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vm_name = '{{ vm_name }}' --required
AND vm_extension_name = '{{ vm_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete the extension.

DELETE FROM azure.compute.virtual_machine_extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vm_name = '{{ vm_name }}' --required
AND vm_extension_name = '{{ vm_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;