Share via

Microsoft.AzureStackHCI clusters/arcSettings

Bicep resource definition

The clusters/arcSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/clusters/arcSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/clusters/arcSettings@2026-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    arcApplicationClientId: 'string'
    arcApplicationObjectId: 'string'
    arcApplicationTenantId: 'string'
    arcInstanceResourceGroup: 'string'
    arcServicePrincipalObjectId: 'string'
    connectivityProperties: {
      enabled: bool
      serviceConfigurations: [
        {
          port: int
          serviceName: 'string'
        }
      ]
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: clusters
properties ArcSetting properties. ArcSettingProperties

ArcConnectivityProperties

Name Description Value
enabled True indicates ARC connectivity is enabled bool
serviceConfigurations Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ServiceConfiguration[]

ArcSettingProperties

Name Description Value
arcApplicationClientId App id of arc AAD identity. string
arcApplicationObjectId Object id of arc AAD identity. string
arcApplicationTenantId Tenant id of arc AAD identity. string
arcInstanceResourceGroup The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. string
arcServicePrincipalObjectId Object id of arc AAD service principal. string
connectivityProperties contains connectivity related configuration for ARC resources ArcConnectivityProperties

ServiceConfiguration

Name Description Value
port The port on which service is enabled. int (required)
serviceName Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. 'WAC' (required)

ARM template resource definition

The clusters/arcSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/clusters/arcSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
  "apiVersion": "2026-03-01-preview",
  "name": "string",
  "properties": {
    "arcApplicationClientId": "string",
    "arcApplicationObjectId": "string",
    "arcApplicationTenantId": "string",
    "arcInstanceResourceGroup": "string",
    "arcServicePrincipalObjectId": "string",
    "connectivityProperties": {
      "enabled": "bool",
      "serviceConfigurations": [
        {
          "port": "int",
          "serviceName": "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings

Name Description Value
apiVersion The api version '2026-03-01-preview'
name The resource name string (required)
properties ArcSetting properties. ArcSettingProperties
type The resource type 'Microsoft.AzureStackHCI/clusters/arcSettings'

ArcConnectivityProperties

Name Description Value
enabled True indicates ARC connectivity is enabled bool
serviceConfigurations Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ServiceConfiguration[]

ArcSettingProperties

Name Description Value
arcApplicationClientId App id of arc AAD identity. string
arcApplicationObjectId Object id of arc AAD identity. string
arcApplicationTenantId Tenant id of arc AAD identity. string
arcInstanceResourceGroup The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. string
arcServicePrincipalObjectId Object id of arc AAD service principal. string
connectivityProperties contains connectivity related configuration for ARC resources ArcConnectivityProperties

ServiceConfiguration

Name Description Value
port The port on which service is enabled. int (required)
serviceName Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. 'WAC' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The clusters/arcSettings resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/clusters/arcSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/clusters/arcSettings@2026-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      arcApplicationClientId = "string"
      arcApplicationObjectId = "string"
      arcApplicationTenantId = "string"
      arcInstanceResourceGroup = "string"
      arcServicePrincipalObjectId = "string"
      connectivityProperties = {
        enabled = bool
        serviceConfigurations = [
          {
            port = int
            serviceName = "string"
          }
        ]
      }
    }
  }
}

Property Values

Microsoft.AzureStackHCI/clusters/arcSettings

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters
properties ArcSetting properties. ArcSettingProperties
type The resource type "Microsoft.AzureStackHCI/clusters/arcSettings@2026-03-01-preview"

ArcConnectivityProperties

Name Description Value
enabled True indicates ARC connectivity is enabled bool
serviceConfigurations Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ServiceConfiguration[]

ArcSettingProperties

Name Description Value
arcApplicationClientId App id of arc AAD identity. string
arcApplicationObjectId Object id of arc AAD identity. string
arcApplicationTenantId Tenant id of arc AAD identity. string
arcInstanceResourceGroup The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. string
arcServicePrincipalObjectId Object id of arc AAD service principal. string
connectivityProperties contains connectivity related configuration for ARC resources ArcConnectivityProperties

ServiceConfiguration

Name Description Value
port The port on which service is enabled. int (required)
serviceName Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. 'WAC' (required)
  • Last updated on