1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. ArcSetting
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.azurestackhci.ArcSetting

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    ArcSetting details. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2021-01-01-preview.

    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.

    Example Usage

    Create ArcSetting

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var arcSetting = new AzureNative.AzureStackHCI.ArcSetting("arcSetting", new()
        {
            ArcSettingName = "default",
            ClusterName = "myCluster",
            ResourceGroupName = "test-rg",
        });
    
    });
    
    package main
    
    import (
    	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := azurestackhci.NewArcSetting(ctx, "arcSetting", &azurestackhci.ArcSettingArgs{
    			ArcSettingName:    pulumi.String("default"),
    			ClusterName:       pulumi.String("myCluster"),
    			ResourceGroupName: pulumi.String("test-rg"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.azurestackhci.ArcSetting;
    import com.pulumi.azurenative.azurestackhci.ArcSettingArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var arcSetting = new ArcSetting("arcSetting", ArcSettingArgs.builder()
                .arcSettingName("default")
                .clusterName("myCluster")
                .resourceGroupName("test-rg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    arc_setting = azure_native.azurestackhci.ArcSetting("arcSetting",
        arc_setting_name="default",
        cluster_name="myCluster",
        resource_group_name="test-rg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const arcSetting = new azure_native.azurestackhci.ArcSetting("arcSetting", {
        arcSettingName: "default",
        clusterName: "myCluster",
        resourceGroupName: "test-rg",
    });
    
    resources:
      arcSetting:
        type: azure-native:azurestackhci:ArcSetting
        properties:
          arcSettingName: default
          clusterName: myCluster
          resourceGroupName: test-rg
    

    Create ArcSetting Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ArcSetting(name: string, args: ArcSettingArgs, opts?: CustomResourceOptions);
    @overload
    def ArcSetting(resource_name: str,
                   args: ArcSettingArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ArcSetting(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cluster_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   arc_application_client_id: Optional[str] = None,
                   arc_application_object_id: Optional[str] = None,
                   arc_application_tenant_id: Optional[str] = None,
                   arc_instance_resource_group: Optional[str] = None,
                   arc_service_principal_object_id: Optional[str] = None,
                   arc_setting_name: Optional[str] = None,
                   connectivity_properties: Optional[Sequence[ArcConnectivityPropertiesArgs]] = None)
    func NewArcSetting(ctx *Context, name string, args ArcSettingArgs, opts ...ResourceOption) (*ArcSetting, error)
    public ArcSetting(string name, ArcSettingArgs args, CustomResourceOptions? opts = null)
    public ArcSetting(String name, ArcSettingArgs args)
    public ArcSetting(String name, ArcSettingArgs args, CustomResourceOptions options)
    
    type: azure-native:azurestackhci:ArcSetting
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ArcSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ArcSettingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ArcSettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ArcSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ArcSettingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var arcSettingResource = new AzureNative.AzureStackHCI.ArcSetting("arcSettingResource", new()
    {
        ClusterName = "string",
        ResourceGroupName = "string",
        ArcApplicationClientId = "string",
        ArcApplicationObjectId = "string",
        ArcApplicationTenantId = "string",
        ArcInstanceResourceGroup = "string",
        ArcServicePrincipalObjectId = "string",
        ArcSettingName = "string",
        ConnectivityProperties = new[]
        {
            new AzureNative.AzureStackHCI.Inputs.ArcConnectivityPropertiesArgs
            {
                Enabled = false,
            },
        },
    });
    
    example, err := azurestackhci.NewArcSetting(ctx, "arcSettingResource", &azurestackhci.ArcSettingArgs{
    	ClusterName:                 pulumi.String("string"),
    	ResourceGroupName:           pulumi.String("string"),
    	ArcApplicationClientId:      pulumi.String("string"),
    	ArcApplicationObjectId:      pulumi.String("string"),
    	ArcApplicationTenantId:      pulumi.String("string"),
    	ArcInstanceResourceGroup:    pulumi.String("string"),
    	ArcServicePrincipalObjectId: pulumi.String("string"),
    	ArcSettingName:              pulumi.String("string"),
    	ConnectivityProperties: azurestackhci.ArcConnectivityPropertiesArray{
    		&azurestackhci.ArcConnectivityPropertiesArgs{
    			Enabled: pulumi.Bool(false),
    		},
    	},
    })
    
    var arcSettingResource = new ArcSetting("arcSettingResource", ArcSettingArgs.builder()
        .clusterName("string")
        .resourceGroupName("string")
        .arcApplicationClientId("string")
        .arcApplicationObjectId("string")
        .arcApplicationTenantId("string")
        .arcInstanceResourceGroup("string")
        .arcServicePrincipalObjectId("string")
        .arcSettingName("string")
        .connectivityProperties(ArcConnectivityPropertiesArgs.builder()
            .enabled(false)
            .build())
        .build());
    
    arc_setting_resource = azure_native.azurestackhci.ArcSetting("arcSettingResource",
        cluster_name="string",
        resource_group_name="string",
        arc_application_client_id="string",
        arc_application_object_id="string",
        arc_application_tenant_id="string",
        arc_instance_resource_group="string",
        arc_service_principal_object_id="string",
        arc_setting_name="string",
        connectivity_properties=[{
            "enabled": False,
        }])
    
    const arcSettingResource = new azure_native.azurestackhci.ArcSetting("arcSettingResource", {
        clusterName: "string",
        resourceGroupName: "string",
        arcApplicationClientId: "string",
        arcApplicationObjectId: "string",
        arcApplicationTenantId: "string",
        arcInstanceResourceGroup: "string",
        arcServicePrincipalObjectId: "string",
        arcSettingName: "string",
        connectivityProperties: [{
            enabled: false,
        }],
    });
    
    type: azure-native:azurestackhci:ArcSetting
    properties:
        arcApplicationClientId: string
        arcApplicationObjectId: string
        arcApplicationTenantId: string
        arcInstanceResourceGroup: string
        arcServicePrincipalObjectId: string
        arcSettingName: string
        clusterName: string
        connectivityProperties:
            - enabled: false
        resourceGroupName: string
    

    ArcSetting Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ArcSetting resource accepts the following input properties:

    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    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.
    ArcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    ConnectivityProperties List<Pulumi.AzureNative.AzureStackHCI.Inputs.ArcConnectivityProperties>
    contains connectivity related configuration for ARC resources
    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    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.
    ArcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    ConnectivityProperties []ArcConnectivityPropertiesArgs
    contains connectivity related configuration for ARC resources
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    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.
    arcSettingName String
    The name of the proxy resource holding details of HCI ArcSetting information.
    connectivityProperties List<ArcConnectivityProperties>
    contains connectivity related configuration for ARC resources
    clusterName string
    The name of the cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    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.
    arcSettingName string
    The name of the proxy resource holding details of HCI ArcSetting information.
    connectivityProperties ArcConnectivityProperties[]
    contains connectivity related configuration for ARC resources
    cluster_name str
    The name of the cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    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.
    arc_setting_name str
    The name of the proxy resource holding details of HCI ArcSetting information.
    connectivity_properties Sequence[ArcConnectivityPropertiesArgs]
    contains connectivity related configuration for ARC resources
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    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.
    arcSettingName String
    The name of the proxy resource holding details of HCI ArcSetting information.
    connectivityProperties List<Property Map>
    contains connectivity related configuration for ARC resources

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ArcSetting resource produces the following output properties:

    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
    The provider-assigned unique ID for this managed resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    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"

    Supporting Types

    ArcConnectivityProperties, ArcConnectivityPropertiesArgs

    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

    ArcConnectivityPropertiesResponse, ArcConnectivityPropertiesResponseArgs

    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, DefaultExtensionDetailsResponseArgs

    Category string
    Default extension category
    ConsentTime string
    Consent time for extension category
    Category string
    Default extension category
    ConsentTime string
    Consent time for extension category
    category String
    Default extension category
    consentTime String
    Consent time for extension category
    category string
    Default extension category
    consentTime string
    Consent time for extension category
    category str
    Default extension category
    consent_time str
    Consent time for extension category
    category String
    Default extension category
    consentTime String
    Consent time for extension category

    PerNodeStateResponse, PerNodeStateResponseArgs

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

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:azurestackhci:ArcSetting myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi