azure-native.azurestackhci.ArcSetting
Explore with Pulumi AI
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:
- Cluster
Name string - The name of the cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Arc
Application stringClient Id - App id of arc AAD identity.
- Arc
Application stringObject Id - Object id of arc AAD identity.
- Arc
Application stringTenant Id - Tenant id of arc AAD identity.
- Arc
Instance stringResource Group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- Arc
Service stringPrincipal Object Id - Object id of arc AAD service principal.
- Arc
Setting stringName - The name of the proxy resource holding details of HCI ArcSetting information.
- Connectivity
Properties List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Arc Connectivity Properties> - contains connectivity related configuration for ARC resources
- Cluster
Name string - The name of the cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Arc
Application stringClient Id - App id of arc AAD identity.
- Arc
Application stringObject Id - Object id of arc AAD identity.
- Arc
Application stringTenant Id - Tenant id of arc AAD identity.
- Arc
Instance stringResource Group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- Arc
Service stringPrincipal Object Id - Object id of arc AAD service principal.
- Arc
Setting stringName - The name of the proxy resource holding details of HCI ArcSetting information.
- Connectivity
Properties []ArcConnectivity Properties Args - contains connectivity related configuration for ARC resources
- cluster
Name String - The name of the cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- arc
Application StringClient Id - App id of arc AAD identity.
- arc
Application StringObject Id - Object id of arc AAD identity.
- arc
Application StringTenant Id - Tenant id of arc AAD identity.
- arc
Instance StringResource Group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- arc
Service StringPrincipal Object Id - Object id of arc AAD service principal.
- arc
Setting StringName - The name of the proxy resource holding details of HCI ArcSetting information.
- connectivity
Properties List<ArcConnectivity Properties> - contains connectivity related configuration for ARC resources
- cluster
Name string - The name of the cluster.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- arc
Application stringClient Id - App id of arc AAD identity.
- arc
Application stringObject Id - Object id of arc AAD identity.
- arc
Application stringTenant Id - Tenant id of arc AAD identity.
- arc
Instance stringResource Group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- arc
Service stringPrincipal Object Id - Object id of arc AAD service principal.
- arc
Setting stringName - The name of the proxy resource holding details of HCI ArcSetting information.
- connectivity
Properties ArcConnectivity Properties[] - contains connectivity related configuration for ARC resources
- cluster_
name str - The name of the cluster.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- arc_
application_ strclient_ id - App id of arc AAD identity.
- arc_
application_ strobject_ id - Object id of arc AAD identity.
- arc_
application_ strtenant_ id - Tenant id of arc AAD identity.
- arc_
instance_ strresource_ group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- arc_
service_ strprincipal_ object_ id - Object id of arc AAD service principal.
- arc_
setting_ strname - The name of the proxy resource holding details of HCI ArcSetting information.
- connectivity_
properties Sequence[ArcConnectivity Properties Args] - contains connectivity related configuration for ARC resources
- cluster
Name String - The name of the cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- arc
Application StringClient Id - App id of arc AAD identity.
- arc
Application StringObject Id - Object id of arc AAD identity.
- arc
Application StringTenant Id - Tenant id of arc AAD identity.
- arc
Instance StringResource Group - The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
- arc
Service StringPrincipal Object Id - Object id of arc AAD service principal.
- arc
Setting StringName - The name of the proxy resource holding details of HCI ArcSetting information.
- connectivity
Properties 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:
- Aggregate
State string - Aggregate state of Arc agent across the nodes in this HCI cluster.
- Default
Extensions List<Pulumi.Azure Native. Azure Stack HCI. Outputs. Default Extension Details Response> - 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
- Per
Node List<Pulumi.Details Azure Native. Azure Stack HCI. Outputs. Per Node State Response> - State of Arc agent in each of the nodes.
- Provisioning
State string - Provisioning state of the ArcSetting proxy resource.
- System
Data Pulumi.Azure Native. Azure Stack HCI. Outputs. System Data Response - 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 string - Aggregate state of Arc agent across the nodes in this HCI cluster.
- Default
Extensions []DefaultExtension Details Response - 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
- Per
Node []PerDetails Node State Response - State of Arc agent in each of the nodes.
- Provisioning
State string - Provisioning state of the ArcSetting proxy resource.
- System
Data SystemData Response - 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 String - Aggregate state of Arc agent across the nodes in this HCI cluster.
- default
Extensions List<DefaultExtension Details Response> - 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
- per
Node List<PerDetails Node State Response> - State of Arc agent in each of the nodes.
- provisioning
State String - Provisioning state of the ArcSetting proxy resource.
- system
Data SystemData Response - 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 string - Aggregate state of Arc agent across the nodes in this HCI cluster.
- default
Extensions DefaultExtension Details Response[] - 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
- per
Node PerDetails Node State Response[] - State of Arc agent in each of the nodes.
- provisioning
State string - Provisioning state of the ArcSetting proxy resource.
- system
Data SystemData Response - 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[DefaultExtension Details Response] - 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_ Sequence[Perdetails Node State Response] - State of Arc agent in each of the nodes.
- provisioning_
state str - Provisioning state of the ArcSetting proxy resource.
- system_
data SystemData Response - 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"
- aggregate
State String - Aggregate state of Arc agent across the nodes in this HCI cluster.
- default
Extensions 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
- per
Node List<Property Map>Details - State of Arc agent in each of the nodes.
- provisioning
State String - Provisioning state of the ArcSetting proxy resource.
- system
Data 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
- Consent
Time string - Consent time for extension category
- Category string
- Default extension category
- Consent
Time string - Consent time for extension category
- category String
- Default extension category
- consent
Time String - Consent time for extension category
- category string
- Default extension category
- consent
Time string - Consent time for extension category
- category str
- Default extension category
- consent_
time str - Consent time for extension category
- category String
- Default extension category
- consent
Time String - Consent time for extension category
PerNodeStateResponse, PerNodeStateResponseArgs
- Arc
Instance 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 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 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 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.
- arc
Instance 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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