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
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.
aggregateState	string	Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. Known values are: "NotSpecified", "Error", "Succeeded", "Canceled", "Failed", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "UpgradeFailedRollbackSucceeded". (NotSpecified, Error, Succeeded, Canceled, Failed, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, UpgradeFailedRollbackSucceeded)
extensionParameters	object	Parameters specific to this extension type.
managedBy	string	Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. Known values are: "User" and "Azure". (User, Azure)
perNodeExtensionDetails	array	State of Arc Extension in each of the nodes.
provisioningState	string	Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_arc_setting

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.
aggregateState	string	Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. Known values are: "NotSpecified", "Error", "Succeeded", "Canceled", "Failed", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "UpgradeFailedRollbackSucceeded". (NotSpecified, Error, Succeeded, Canceled, Failed, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, UpgradeFailedRollbackSucceeded)
extensionParameters	object	Parameters specific to this extension type.
managedBy	string	Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. Known values are: "User" and "Azure". (User, Azure)
perNodeExtensionDetails	array	State of Arc Extension in each of the nodes.
provisioningState	string	Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, arc_setting_name, extension_name, subscription_id		Get particular Arc Extension of HCI Cluster.
list_by_arc_setting	select	resource_group_name, cluster_name, arc_setting_name, subscription_id		List all Extensions under ArcSetting resource.
create	insert	resource_group_name, cluster_name, arc_setting_name, extension_name, subscription_id		Create Extension for HCI cluster.
update	update	resource_group_name, cluster_name, arc_setting_name, extension_name, subscription_id		Update Extension for HCI cluster.
delete	delete	resource_group_name, cluster_name, arc_setting_name, extension_name, subscription_id		Delete particular Arc Extension of HCI Cluster.
upgrade	exec	resource_group_name, cluster_name, arc_setting_name, extension_name, subscription_id		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
arc_setting_name	string	The name of the proxy resource holding details of HCI ArcSetting information. Required.
cluster_name	string	The name of the cluster. Required.
extension_name	string	The name of the machine extension. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get particular Arc Extension of HCI Cluster.

SELECT
id,
name,
aggregateState,
extensionParameters,
managedBy,
perNodeExtensionDetails,
provisioningState,
systemData,
type
FROM azure_stack.azure_stack_hci.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND arc_setting_name = '{{ arc_setting_name }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_arc_setting

List all Extensions under ArcSetting resource.

SELECT
id,
name,
aggregateState,
extensionParameters,
managedBy,
perNodeExtensionDetails,
provisioningState,
systemData,
type
FROM azure_stack.azure_stack_hci.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND arc_setting_name = '{{ arc_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Extension for HCI cluster.

INSERT INTO azure_stack.azure_stack_hci.extensions (
properties,
resource_group_name,
cluster_name,
arc_setting_name,
extension_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ arc_setting_name }}',
'{{ extension_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the extensions resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the extensions resource.
  - name: arc_setting_name
    value: "{{ arc_setting_name }}"
    description: Required parameter for the extensions resource.
  - name: extension_name
    value: "{{ extension_name }}"
    description: Required parameter for the extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the extensions resource.
  - name: properties
    description: |
      Describes Machine Extension Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      extensionParameters:
        forceUpdateTag: "{{ forceUpdateTag }}"
        publisher: "{{ publisher }}"
        type: "{{ type }}"
        typeHandlerVersion: "{{ typeHandlerVersion }}"
        autoUpgradeMinorVersion: {{ autoUpgradeMinorVersion }}
        settings: "{{ settings }}"
        protectedSettings: "{{ protectedSettings }}"
        enableAutomaticUpgrade: {{ enableAutomaticUpgrade }}
      aggregateState: "{{ aggregateState }}"
      perNodeExtensionDetails:
        - name: "{{ name }}"
          extension: "{{ extension }}"
          typeHandlerVersion: "{{ typeHandlerVersion }}"
          state: "{{ state }}"
          instanceView:
            name: "{{ name }}"
            type: "{{ type }}"
            typeHandlerVersion: "{{ typeHandlerVersion }}"
            status:
              code: "{{ code }}"
              level: "{{ level }}"
              displayStatus: "{{ displayStatus }}"
              message: "{{ message }}"
              time: "{{ time }}"
      managedBy: "{{ managedBy }}"

UPDATE examples

update

Update Extension for HCI cluster.

UPDATE azure_stack.azure_stack_hci.extensions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND arc_setting_name = '{{ arc_setting_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete particular Arc Extension of HCI Cluster.

DELETE FROM azure_stack.azure_stack_hci.extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND arc_setting_name = '{{ arc_setting_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

upgrade

Upgrade a particular Arc Extension of HCI Cluster.

EXEC azure_stack.azure_stack_hci.extensions.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@extension_name='{{ extension_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"targetVersion": "{{ targetVersion }}"
}'
;