extensions

Creates, updates, deletes, gets or lists an extensions resource.

Overview

Name	extensions
Type	Resource
Id	azure_stack.azure_stack_hci.extensions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Describes Machine Extension Properties.

list_by_arc_setting

Name	Datatype	Description
properties	object	Describes Machine Extension Properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, arcSettingName, extensionName		Get particular Arc Extension of HCI Cluster.
list_by_arc_setting	select	subscriptionId, resourceGroupName, clusterName, arcSettingName		List all Extensions under ArcSetting resource.
create	insert	subscriptionId, resourceGroupName, clusterName, arcSettingName, extensionName		Create Extension for HCI cluster.
update	update	subscriptionId, resourceGroupName, clusterName, arcSettingName, extensionName		Update Extension for HCI cluster.
delete	delete	subscriptionId, resourceGroupName, clusterName, arcSettingName, extensionName		Delete particular Arc Extension of HCI Cluster.
upgrade	exec	subscriptionId, resourceGroupName, clusterName, arcSettingName, extensionName		Upgrade a particular Arc Extension of HCI Cluster.

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
arcSettingName	string	The name of the proxy resource holding details of HCI ArcSetting information.
clusterName	string	The name of the cluster.
extensionName	string	The name of the machine extension.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get particular Arc Extension of HCI Cluster.

SELECT
properties
FROM azure_stack.azure_stack_hci.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND arcSettingName = '{{ arcSettingName }}' -- required
AND extensionName = '{{ extensionName }}' -- required
;

list_by_arc_setting

List all Extensions under ArcSetting resource.

SELECT
properties
FROM azure_stack.azure_stack_hci.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND arcSettingName = '{{ arcSettingName }}' -- required
;

INSERT examples

create

Create Extension for HCI cluster.

INSERT INTO azure_stack.azure_stack_hci.extensions (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
arcSettingName,
extensionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ arcSettingName }}',
'{{ extensionName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: extensions
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the extensions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the extensions resource.
    - name: clusterName
      value: string
      description: Required parameter for the extensions resource.
    - name: arcSettingName
      value: string
      description: Required parameter for the extensions resource.
    - name: extensionName
      value: string
      description: Required parameter for the extensions resource.
    - name: properties
      value: object
      description: |
        Describes Machine Extension Properties.

UPDATE examples

update

Update Extension for HCI cluster.

UPDATE azure_stack.azure_stack_hci.extensions
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND arcSettingName = '{{ arcSettingName }}' --required
AND extensionName = '{{ extensionName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete particular Arc Extension of HCI Cluster.

DELETE FROM azure_stack.azure_stack_hci.extensions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND arcSettingName = '{{ arcSettingName }}' --required
AND extensionName = '{{ extensionName }}' --required
;

Lifecycle Methods

upgrade

Upgrade a particular Arc Extension of HCI Cluster.

EXEC azure_stack.azure_stack_hci.extensions.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@arcSettingName='{{ arcSettingName }}' --required, 
@extensionName='{{ extensionName }}' --required 
@@json=
'{
"targetVersion": "{{ targetVersion }}"
}'
;