virtual_machine_scale_set_extensions

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

Overview

Name	virtual_machine_scale_set_extensions
Type	Resource
Id	azure.compute.virtual_machine_scale_set_extensions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
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	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
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.
type	string	Resource type.
typeHandlerVersion	string	Specifies the version of the script handler.

list

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
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	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
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.
type	string	Resource type.
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_scale_set_name, vmss_extension_name, subscription_id	$expand	The operation to get the extension.
list	select	resource_group_name, vm_scale_set_name, subscription_id		Gets a list of all extensions in a VM scale set.
create_or_update	insert	resource_group_name, vm_scale_set_name, vmss_extension_name, subscription_id		The operation to create or update an extension.
update	update	resource_group_name, vm_scale_set_name, vmss_extension_name, subscription_id		The operation to update an extension.
create_or_update	replace	resource_group_name, vm_scale_set_name, vmss_extension_name, subscription_id		The operation to create or update an extension.
delete	delete	resource_group_name, vm_scale_set_name, vmss_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_scale_set_name	string	The name of the VM scale set. Required.
vmss_extension_name	string	The name of the VM scale set extension. 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,
protectedSettings,
protectedSettingsFromKeyVault,
provisionAfterExtensions,
provisioningState,
publisher,
settings,
suppressFailures,
type,
typeHandlerVersion
FROM azure.compute.virtual_machine_scale_set_extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' -- required
AND vmss_extension_name = '{{ vmss_extension_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets a list of all extensions in a VM scale set.

SELECT
id,
name,
autoUpgradeMinorVersion,
enableAutomaticUpgrade,
forceUpdateTag,
protectedSettings,
protectedSettingsFromKeyVault,
provisionAfterExtensions,
provisioningState,
publisher,
settings,
suppressFailures,
type,
typeHandlerVersion
FROM azure.compute.virtual_machine_scale_set_extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

The operation to create or update an extension.

INSERT INTO azure.compute.virtual_machine_scale_set_extensions (
name,
properties,
resource_group_name,
vm_scale_set_name,
vmss_extension_name,
subscription_id
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vm_scale_set_name }}',
'{{ vmss_extension_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machine_scale_set_extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_machine_scale_set_extensions resource.
  - name: vm_scale_set_name
    value: "{{ vm_scale_set_name }}"
    description: Required parameter for the virtual_machine_scale_set_extensions resource.
  - name: vmss_extension_name
    value: "{{ vmss_extension_name }}"
    description: Required parameter for the virtual_machine_scale_set_extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_machine_scale_set_extensions resource.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: properties
    description: |
      Describes the properties of a Virtual Machine Scale Set Extension.
    value:
      forceUpdateTag: "{{ forceUpdateTag }}"
      publisher: "{{ publisher }}"
      type: "{{ type }}"
      typeHandlerVersion: "{{ typeHandlerVersion }}"
      autoUpgradeMinorVersion: {{ autoUpgradeMinorVersion }}
      enableAutomaticUpgrade: {{ enableAutomaticUpgrade }}
      settings: "{{ settings }}"
      protectedSettings: "{{ protectedSettings }}"
      provisioningState: "{{ provisioningState }}"
      provisionAfterExtensions:
        - "{{ provisionAfterExtensions }}"
      suppressFailures: {{ suppressFailures }}
      protectedSettingsFromKeyVault:
        secretUrl: "{{ secretUrl }}"
        sourceVault:
          id: "{{ id }}"

UPDATE examples

update

The operation to update an extension.

UPDATE azure.compute.virtual_machine_scale_set_extensions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' --required
AND vmss_extension_name = '{{ vmss_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_update

The operation to create or update an extension.

REPLACE azure.compute.virtual_machine_scale_set_extensions
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' --required
AND vmss_extension_name = '{{ vmss_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

The operation to delete the extension.

DELETE FROM azure.compute.virtual_machine_scale_set_extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' --required
AND vmss_extension_name = '{{ vmss_extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;