arc_settings

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

Overview

Name	arc_settings
Type	Resource
Id	azure_stack.azure_stack_hci.arc_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	ArcSetting properties.

list_by_cluster

Name	Datatype	Description
properties	object	ArcSetting properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, arcSettingName		Get ArcSetting resource details of HCI Cluster.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Get ArcSetting resources of HCI Cluster.
create	insert	subscriptionId, resourceGroupName, clusterName, arcSettingName		Create ArcSetting for HCI cluster.
update	update	subscriptionId, resourceGroupName, clusterName, arcSettingName		Update ArcSettings for HCI cluster.
delete	delete	subscriptionId, resourceGroupName, clusterName, arcSettingName		Delete ArcSetting resource details of HCI Cluster.
generate_password	exec	subscriptionId, resourceGroupName, clusterName, arcSettingName		Generate password for arc settings.
consent_and_install_default_extensions	exec	subscriptionId, resourceGroupName, clusterName, arcSettingName		Add consent time for default extensions and initiate extensions installation
initialize_disable_process	exec	subscriptionId, resourceGroupName, clusterName, arcSettingName		Initializes ARC Disable process on the 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.
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 ArcSetting resource details of HCI Cluster.

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

list_by_cluster

Get ArcSetting resources of HCI Cluster.

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

INSERT examples

create

Create ArcSetting for HCI cluster.

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

Manifest

# Description fields are for documentation purposes
- name: arc_settings
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the arc_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the arc_settings resource.
    - name: clusterName
      value: string
      description: Required parameter for the arc_settings resource.
    - name: arcSettingName
      value: string
      description: Required parameter for the arc_settings resource.
    - name: properties
      value: object
      description: |
        ArcSetting properties.

UPDATE examples

update

Update ArcSettings for HCI cluster.

UPDATE azure_stack.azure_stack_hci.arc_settings
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND arcSettingName = '{{ arcSettingName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete ArcSetting resource details of HCI Cluster.

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

Lifecycle Methods

generate_password

Generate password for arc settings.

EXEC azure_stack.azure_stack_hci.arc_settings.generate_password 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@arcSettingName='{{ arcSettingName }}' --required
;

consent_and_install_default_extensions

Add consent time for default extensions and initiate extensions installation

EXEC azure_stack.azure_stack_hci.arc_settings.consent_and_install_default_extensions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@arcSettingName='{{ arcSettingName }}' --required
;

initialize_disable_process

Initializes ARC Disable process on the cluster

EXEC azure_stack.azure_stack_hci.arc_settings.initialize_disable_process 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@arcSettingName='{{ arcSettingName }}' --required
;