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
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 agent across the nodes in this HCI cluster. Known values are: "NotSpecified", "Error", "Succeeded", "Canceled", "Failed", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Canceled, Failed, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
arcApplicationClientId	string	App id of arc AAD identity.
arcApplicationObjectId	string	Object id of arc AAD identity.
arcApplicationTenantId	string	Tenant id of arc AAD identity.
arcInstanceResourceGroup	string	The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
arcServicePrincipalObjectId	string	Object id of arc AAD service principal.
connectivityProperties	object	contains connectivity related configuration for ARC resources.
defaultExtensions	array	Properties for each of the default extensions category.
perNodeDetails	array	State of Arc agent in each of the nodes.
provisioningState	string	Provisioning state of the ArcSetting proxy resource. 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_cluster

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 agent across the nodes in this HCI cluster. Known values are: "NotSpecified", "Error", "Succeeded", "Canceled", "Failed", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Canceled, Failed, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
arcApplicationClientId	string	App id of arc AAD identity.
arcApplicationObjectId	string	Object id of arc AAD identity.
arcApplicationTenantId	string	Tenant id of arc AAD identity.
arcInstanceResourceGroup	string	The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
arcServicePrincipalObjectId	string	Object id of arc AAD service principal.
connectivityProperties	object	contains connectivity related configuration for ARC resources.
defaultExtensions	array	Properties for each of the default extensions category.
perNodeDetails	array	State of Arc agent in each of the nodes.
provisioningState	string	Provisioning state of the ArcSetting proxy resource. 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, subscription_id		Get ArcSetting resource details of HCI Cluster.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Get ArcSetting resources of HCI Cluster.
create	insert	resource_group_name, cluster_name, arc_setting_name, subscription_id		Create ArcSetting for HCI cluster.
update	update	resource_group_name, cluster_name, arc_setting_name, subscription_id		Update ArcSettings for HCI cluster.
delete	delete	resource_group_name, cluster_name, arc_setting_name, subscription_id		Delete ArcSetting resource details of HCI Cluster.
generate_password	exec	resource_group_name, cluster_name, arc_setting_name, subscription_id		Generate password for arc settings.
create_identity	exec	resource_group_name, cluster_name, arc_setting_name, subscription_id		Create Aad identity for arc settings.
reconcile	exec	resource_group_name, cluster_name, arc_setting_name, subscription_id		Reconcile Arc Settings with information related to all nodes.
consent_and_install_default_extensions	exec	resource_group_name, cluster_name, arc_setting_name, subscription_id		Add consent time for default extensions and initiate extensions installation.
initialize_disable_process	exec	resource_group_name, cluster_name, arc_setting_name, subscription_id		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
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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get ArcSetting resource details of HCI Cluster.

SELECT
id,
name,
aggregateState,
arcApplicationClientId,
arcApplicationObjectId,
arcApplicationTenantId,
arcInstanceResourceGroup,
arcServicePrincipalObjectId,
connectivityProperties,
defaultExtensions,
perNodeDetails,
provisioningState,
systemData,
type
FROM azure_stack.azure_stack_hci.arc_settings
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
;

list_by_cluster

Get ArcSetting resources of HCI Cluster.

SELECT
id,
name,
aggregateState,
arcApplicationClientId,
arcApplicationObjectId,
arcApplicationTenantId,
arcInstanceResourceGroup,
arcServicePrincipalObjectId,
connectivityProperties,
defaultExtensions,
perNodeDetails,
provisioningState,
systemData,
type
FROM azure_stack.azure_stack_hci.arc_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create ArcSetting for HCI cluster.

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

Manifest

# Description fields are for documentation purposes
- name: arc_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the arc_settings resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the arc_settings resource.
  - name: arc_setting_name
    value: "{{ arc_setting_name }}"
    description: Required parameter for the arc_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the arc_settings resource.
  - name: properties
    description: |
      ArcSetting properties.
    value:
      provisioningState: "{{ provisioningState }}"
      arcInstanceResourceGroup: "{{ arcInstanceResourceGroup }}"
      arcApplicationClientId: "{{ arcApplicationClientId }}"
      arcApplicationTenantId: "{{ arcApplicationTenantId }}"
      arcServicePrincipalObjectId: "{{ arcServicePrincipalObjectId }}"
      arcApplicationObjectId: "{{ arcApplicationObjectId }}"
      aggregateState: "{{ aggregateState }}"
      perNodeDetails:
        - name: "{{ name }}"
          arcInstance: "{{ arcInstance }}"
          arcNodeServicePrincipalObjectId: "{{ arcNodeServicePrincipalObjectId }}"
          state: "{{ state }}"
      connectivityProperties:
        enabled: {{ enabled }}
        serviceConfigurations:
          - serviceName: "{{ serviceName }}"
            port: {{ port }}
      defaultExtensions:
        - category: "{{ category }}"
          consentTime: "{{ consentTime }}"

UPDATE examples

update

Update ArcSettings for HCI cluster.

UPDATE azure_stack.azure_stack_hci.arc_settings
SET 
tags = '{{ tags }}',
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete ArcSetting resource details of HCI Cluster.

DELETE FROM azure_stack.azure_stack_hci.arc_settings
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
;

Lifecycle Methods

generate_password

Generate password for arc settings.

EXEC azure_stack.azure_stack_hci.arc_settings.generate_password 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_identity

Create Aad identity for arc settings.

EXEC azure_stack.azure_stack_hci.arc_settings.create_identity 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reconcile

Reconcile Arc Settings with information related to all nodes.

EXEC azure_stack.azure_stack_hci.arc_settings.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

initialize_disable_process

Initializes ARC Disable process on the cluster.

EXEC azure_stack.azure_stack_hci.arc_settings.initialize_disable_process 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@arc_setting_name='{{ arc_setting_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;