arc_settings

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

Overview

Name	arc_settings
Type	Resource
Id	azure_stack.azure_stack_hci.arc_settings

Fields

vw_arc_settings

Name	Datatype	Description
aggregate_state	text	field from the properties object
arcSettingName	text	field from the properties object
arc_application_client_id	text	field from the properties object
arc_application_object_id	text	field from the properties object
arc_application_tenant_id	text	field from the properties object
arc_instance_resource_group	text	field from the properties object
arc_service_principal_object_id	text	field from the properties object
clusterName	text	field from the properties object
connectivity_properties	text	field from the properties object
default_extensions	text	field from the properties object
per_node_details	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object

arc_settings

Name	Datatype	Description
properties	object	ArcSetting properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	arcSettingName, clusterName, resourceGroupName, subscriptionId	Get ArcSetting resource details of HCI Cluster.
list_by_cluster	SELECT	clusterName, resourceGroupName, subscriptionId	Get ArcSetting resources of HCI Cluster.
create	INSERT	arcSettingName, clusterName, resourceGroupName, subscriptionId	Create ArcSetting for HCI cluster.
delete	DELETE	arcSettingName, clusterName, resourceGroupName, subscriptionId	Delete ArcSetting resource details of HCI Cluster.
update	UPDATE	arcSettingName, clusterName, resourceGroupName, subscriptionId	Update ArcSettings for HCI cluster.
consent_and_install_default_extensions	EXEC	arcSettingName, clusterName, resourceGroupName, subscriptionId	Add consent time for default extensions and initiate extensions installation
generate_password	EXEC	arcSettingName, clusterName, resourceGroupName, subscriptionId	Generate password for arc settings.
initialize_disable_process	EXEC	arcSettingName, clusterName, resourceGroupName, subscriptionId	Initializes ARC Disable process on the cluster

SELECT examples

Get ArcSetting resources of HCI Cluster.

vw_arc_settings

SELECT
aggregate_state,
arcSettingName,
arc_application_client_id,
arc_application_object_id,
arc_application_tenant_id,
arc_instance_resource_group,
arc_service_principal_object_id,
clusterName,
connectivity_properties,
default_extensions,
per_node_details,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure_stack.azure_stack_hci.vw_arc_settings
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

arc_settings

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

INSERT example

Use the following StackQL query and manifest file to create a new arc_settings resource.

All Properties

/*+ create */
INSERT INTO azure_stack.azure_stack_hci.arc_settings (
arcSettingName,
clusterName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ arcSettingName }}',
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: arcInstanceResourceGroup
          value: string
        - name: arcApplicationClientId
          value: string
        - name: arcApplicationTenantId
          value: string
        - name: arcServicePrincipalObjectId
          value: string
        - name: arcApplicationObjectId
          value: string
        - name: aggregateState
          value: string
        - name: perNodeDetails
          value:
            - - name: name
                value: string
              - name: arcInstance
                value: string
              - name: arcNodeServicePrincipalObjectId
                value: string
              - name: state
                value: string
        - name: connectivityProperties
          value: object
        - name: defaultExtensions
          value:
            - - name: category
                value: string
              - name: consentTime
                value: string

UPDATE example

Updates a arc_settings resource.

/*+ update */
UPDATE azure_stack.azure_stack_hci.arc_settings
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
arcSettingName = '{{ arcSettingName }}'
AND clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified arc_settings resource.

/*+ delete */
DELETE FROM azure_stack.azure_stack_hci.arc_settings
WHERE arcSettingName = '{{ arcSettingName }}'
AND clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';