Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurestackhci
  5. getArcSetting
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azurestackhci.getArcSetting

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get ArcSetting resource details of HCI Cluster. Azure REST API version: 2023-03-01.

Other available API versions: 2021-09-01-preview, 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

Using getArcSetting

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getArcSetting(args: GetArcSettingArgs, opts?: InvokeOptions): Promise<GetArcSettingResult>
function getArcSettingOutput(args: GetArcSettingOutputArgs, opts?: InvokeOptions): Output<GetArcSettingResult>
Copy
def get_arc_setting(arc_setting_name: Optional[str] = None,
                    cluster_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetArcSettingResult
def get_arc_setting_output(arc_setting_name: Optional[pulumi.Input[str]] = None,
                    cluster_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetArcSettingResult]
Copy
func LookupArcSetting(ctx *Context, args *LookupArcSettingArgs, opts ...InvokeOption) (*LookupArcSettingResult, error)
func LookupArcSettingOutput(ctx *Context, args *LookupArcSettingOutputArgs, opts ...InvokeOption) LookupArcSettingResultOutput
Copy

> Note: This function is named LookupArcSetting in the Go SDK.

public static class GetArcSetting 
{
    public static Task<GetArcSettingResult> InvokeAsync(GetArcSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetArcSettingResult> Invoke(GetArcSettingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetArcSettingResult> getArcSetting(GetArcSettingArgs args, InvokeOptions options)
public static Output<GetArcSettingResult> getArcSetting(GetArcSettingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestackhci:getArcSetting
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ArcSettingName
This property is required.
Changes to this property will trigger replacement.
string
The name of the proxy resource holding details of HCI ArcSetting information.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ArcSettingName
This property is required.
Changes to this property will trigger replacement.
string
The name of the proxy resource holding details of HCI ArcSetting information.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
arcSettingName
This property is required.
Changes to this property will trigger replacement.
String
The name of the proxy resource holding details of HCI ArcSetting information.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
arcSettingName
This property is required.
Changes to this property will trigger replacement.
string
The name of the proxy resource holding details of HCI ArcSetting information.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
arc_setting_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the proxy resource holding details of HCI ArcSetting information.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
arcSettingName
This property is required.
Changes to this property will trigger replacement.
String
The name of the proxy resource holding details of HCI ArcSetting information.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getArcSetting Result

The following output properties are available:

AggregateState string
Aggregate state of Arc agent across the nodes in this HCI cluster.
DefaultExtensions List<Pulumi.AzureNative.AzureStackHCI.Outputs.DefaultExtensionDetailsResponse>
Properties for each of the default extensions category
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
PerNodeDetails List<Pulumi.AzureNative.AzureStackHCI.Outputs.PerNodeStateResponse>
State of Arc agent in each of the nodes.
ProvisioningState string
Provisioning state of the ArcSetting proxy resource.
SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse
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"
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 List<Pulumi.AzureNative.AzureStackHCI.Outputs.ArcConnectivityPropertiesResponse>
contains connectivity related configuration for ARC resources
AggregateState string
Aggregate state of Arc agent across the nodes in this HCI cluster.
DefaultExtensions []DefaultExtensionDetailsResponse
Properties for each of the default extensions category
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
PerNodeDetails []PerNodeStateResponse
State of Arc agent in each of the nodes.
ProvisioningState string
Provisioning state of the ArcSetting proxy resource.
SystemData SystemDataResponse
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"
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 []ArcConnectivityPropertiesResponse
contains connectivity related configuration for ARC resources
aggregateState String
Aggregate state of Arc agent across the nodes in this HCI cluster.
defaultExtensions List<DefaultExtensionDetailsResponse>
Properties for each of the default extensions category
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
perNodeDetails List<PerNodeStateResponse>
State of Arc agent in each of the nodes.
provisioningState String
Provisioning state of the ArcSetting proxy resource.
systemData SystemDataResponse
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"
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 List<ArcConnectivityPropertiesResponse>
contains connectivity related configuration for ARC resources
aggregateState string
Aggregate state of Arc agent across the nodes in this HCI cluster.
defaultExtensions DefaultExtensionDetailsResponse[]
Properties for each of the default extensions category
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
perNodeDetails PerNodeStateResponse[]
State of Arc agent in each of the nodes.
provisioningState string
Provisioning state of the ArcSetting proxy resource.
systemData SystemDataResponse
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"
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 ArcConnectivityPropertiesResponse[]
contains connectivity related configuration for ARC resources
aggregate_state str
Aggregate state of Arc agent across the nodes in this HCI cluster.
default_extensions Sequence[DefaultExtensionDetailsResponse]
Properties for each of the default extensions category
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
per_node_details Sequence[PerNodeStateResponse]
State of Arc agent in each of the nodes.
provisioning_state str
Provisioning state of the ArcSetting proxy resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
arc_application_client_id str
App id of arc AAD identity.
arc_application_object_id str
Object id of arc AAD identity.
arc_application_tenant_id str
Tenant id of arc AAD identity.
arc_instance_resource_group str
The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
arc_service_principal_object_id str
Object id of arc AAD service principal.
connectivity_properties Sequence[ArcConnectivityPropertiesResponse]
contains connectivity related configuration for ARC resources
aggregateState String
Aggregate state of Arc agent across the nodes in this HCI cluster.
defaultExtensions List<Property Map>
Properties for each of the default extensions category
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
perNodeDetails List<Property Map>
State of Arc agent in each of the nodes.
provisioningState String
Provisioning state of the ArcSetting proxy resource.
systemData Property Map
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"
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 List<Property Map>
contains connectivity related configuration for ARC resources

Supporting Types

ArcConnectivityPropertiesResponse

Enabled bool
True indicates ARC connectivity is enabled
Enabled bool
True indicates ARC connectivity is enabled
enabled Boolean
True indicates ARC connectivity is enabled
enabled boolean
True indicates ARC connectivity is enabled
enabled bool
True indicates ARC connectivity is enabled
enabled Boolean
True indicates ARC connectivity is enabled

DefaultExtensionDetailsResponse

Category This property is required. string
Default extension category
ConsentTime This property is required. string
Consent time for extension category
Category This property is required. string
Default extension category
ConsentTime This property is required. string
Consent time for extension category
category This property is required. String
Default extension category
consentTime This property is required. String
Consent time for extension category
category This property is required. string
Default extension category
consentTime This property is required. string
Consent time for extension category
category This property is required. str
Default extension category
consent_time This property is required. str
Consent time for extension category
category This property is required. String
Default extension category
consentTime This property is required. String
Consent time for extension category

PerNodeStateResponse

ArcInstance This property is required. string
Fully qualified resource ID for the Arc agent of this node.
Name This property is required. string
Name of the Node in HCI Cluster
State This property is required. string
State of Arc agent in this node.
ArcInstance This property is required. string
Fully qualified resource ID for the Arc agent of this node.
Name This property is required. string
Name of the Node in HCI Cluster
State This property is required. string
State of Arc agent in this node.
arcInstance This property is required. String
Fully qualified resource ID for the Arc agent of this node.
name This property is required. String
Name of the Node in HCI Cluster
state This property is required. String
State of Arc agent in this node.
arcInstance This property is required. string
Fully qualified resource ID for the Arc agent of this node.
name This property is required. string
Name of the Node in HCI Cluster
state This property is required. string
State of Arc agent in this node.
arc_instance This property is required. str
Fully qualified resource ID for the Arc agent of this node.
name This property is required. str
Name of the Node in HCI Cluster
state This property is required. str
State of Arc agent in this node.
arcInstance This property is required. String
Fully qualified resource ID for the Arc agent of this node.
name This property is required. String
Name of the Node in HCI Cluster
state This property is required. String
State of Arc agent in this node.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native