Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. arckubernetes
  5. ProvisionedCluster

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.arckubernetes.ProvisionedCluster

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages an Arc Kubernetes Provisioned Cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const current = azure.core.getClientConfig({});
const exampleGroup = new azuread.Group("example", {
    displayName: "example-adg",
    owners: [current.then(current => current.objectId)],
    securityEnabled: true,
});
const exampleProvisionedCluster = new azure.arckubernetes.ProvisionedCluster("example", {
    name: "example-akpc",
    resourceGroupName: example.name,
    location: example.location,
    azureActiveDirectory: {
        azureRbacEnabled: true,
        adminGroupObjectIds: [exampleGroup.id],
        tenantId: current.then(current => current.tenantId),
    },
    identity: {
        type: "SystemAssigned",
    },
});

    import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
current = azure.core.get_client_config()
example_group = azuread.Group("example",
    display_name="example-adg",
    owners=[current.object_id],
    security_enabled=True)
example_provisioned_cluster = azure.arckubernetes.ProvisionedCluster("example",
    name="example-akpc",
    resource_group_name=example.name,
    location=example.location,
    azure_active_directory={
        "azure_rbac_enabled": True,
        "admin_group_object_ids": [example_group.id],
        "tenant_id": current.tenant_id,
    },
    identity={
        "type": "SystemAssigned",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/arckubernetes"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		exampleGroup, err := azuread.NewGroup(ctx, "example", &azuread.GroupArgs{
			DisplayName: pulumi.String("example-adg"),
			Owners: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			SecurityEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = arckubernetes.NewProvisionedCluster(ctx, "example", &arckubernetes.ProvisionedClusterArgs{
			Name:              pulumi.String("example-akpc"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AzureActiveDirectory: &arckubernetes.ProvisionedClusterAzureActiveDirectoryArgs{
				AzureRbacEnabled: pulumi.Bool(true),
				AdminGroupObjectIds: pulumi.StringArray{
					exampleGroup.ID(),
				},
				TenantId: pulumi.String(current.TenantId),
			},
			Identity: &arckubernetes.ProvisionedClusterIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleGroup = new AzureAD.Group("example", new()
    {
        DisplayName = "example-adg",
        Owners = new[]
        {
            current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        },
        SecurityEnabled = true,
    });

    var exampleProvisionedCluster = new Azure.ArcKubernetes.ProvisionedCluster("example", new()
    {
        Name = "example-akpc",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AzureActiveDirectory = new Azure.ArcKubernetes.Inputs.ProvisionedClusterAzureActiveDirectoryArgs
        {
            AzureRbacEnabled = true,
            AdminGroupObjectIds = new[]
            {
                exampleGroup.Id,
            },
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        },
        Identity = new Azure.ArcKubernetes.Inputs.ProvisionedClusterIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azuread.Group;
import com.pulumi.azuread.GroupArgs;
import com.pulumi.azure.arckubernetes.ProvisionedCluster;
import com.pulumi.azure.arckubernetes.ProvisionedClusterArgs;
import com.pulumi.azure.arckubernetes.inputs.ProvisionedClusterAzureActiveDirectoryArgs;
import com.pulumi.azure.arckubernetes.inputs.ProvisionedClusterIdentityArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        final var current = CoreFunctions.getClientConfig();

        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
            .displayName("example-adg")
            .owners(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .securityEnabled(true)
            .build());

        var exampleProvisionedCluster = new ProvisionedCluster("exampleProvisionedCluster", ProvisionedClusterArgs.builder()
            .name("example-akpc")
            .resourceGroupName(example.name())
            .location(example.location())
            .azureActiveDirectory(ProvisionedClusterAzureActiveDirectoryArgs.builder()
                .azureRbacEnabled(true)
                .adminGroupObjectIds(exampleGroup.id())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .build())
            .identity(ProvisionedClusterIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleGroup:
    type: azuread:Group
    name: example
    properties:
      displayName: example-adg
      owners:
        - ${current.objectId}
      securityEnabled: true
  exampleProvisionedCluster:
    type: azure:arckubernetes:ProvisionedCluster
    name: example
    properties:
      name: example-akpc
      resourceGroupName: ${example.name}
      location: ${example.location}
      azureActiveDirectory:
        azureRbacEnabled: true
        adminGroupObjectIds:
          - ${exampleGroup.id}
        tenantId: ${current.tenantId}
      identity:
        type: SystemAssigned
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}

    Create ProvisionedCluster Resource

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

    Constructor syntax

    new ProvisionedCluster(name: string, args: ProvisionedClusterArgs, opts?: CustomResourceOptions);
    @overload
def ProvisionedCluster(resource_name: str,
                       args: ProvisionedClusterArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ProvisionedCluster(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       identity: Optional[ProvisionedClusterIdentityArgs] = None,
                       resource_group_name: Optional[str] = None,
                       arc_agent_auto_upgrade_enabled: Optional[bool] = None,
                       arc_agent_desired_version: Optional[str] = None,
                       azure_active_directory: Optional[ProvisionedClusterAzureActiveDirectoryArgs] = None,
                       location: Optional[str] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewProvisionedCluster(ctx *Context, name string, args ProvisionedClusterArgs, opts ...ResourceOption) (*ProvisionedCluster, error)
    public ProvisionedCluster(string name, ProvisionedClusterArgs args, CustomResourceOptions? opts = null)
    public ProvisionedCluster(String name, ProvisionedClusterArgs args)
public ProvisionedCluster(String name, ProvisionedClusterArgs args, CustomResourceOptions options)

    type: azure:arckubernetes:ProvisionedCluster
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 ProvisionedClusterArgs
    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 ProvisionedClusterArgs
    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 ProvisionedClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProvisionedClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProvisionedClusterArgs
    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 provisionedClusterResource = new Azure.ArcKubernetes.ProvisionedCluster("provisionedClusterResource", new()
{
    Identity = new Azure.ArcKubernetes.Inputs.ProvisionedClusterIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    ResourceGroupName = "string",
    ArcAgentAutoUpgradeEnabled = false,
    ArcAgentDesiredVersion = "string",
    AzureActiveDirectory = new Azure.ArcKubernetes.Inputs.ProvisionedClusterAzureActiveDirectoryArgs
    {
        AdminGroupObjectIds = new[]
        {
            "string",
        },
        AzureRbacEnabled = false,
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := arckubernetes.NewProvisionedCluster(ctx, "provisionedClusterResource", &arckubernetes.ProvisionedClusterArgs{
	Identity: &arckubernetes.ProvisionedClusterIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	ResourceGroupName:          pulumi.String("string"),
	ArcAgentAutoUpgradeEnabled: pulumi.Bool(false),
	ArcAgentDesiredVersion:     pulumi.String("string"),
	AzureActiveDirectory: &arckubernetes.ProvisionedClusterAzureActiveDirectoryArgs{
		AdminGroupObjectIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		AzureRbacEnabled: pulumi.Bool(false),
		TenantId:         pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var provisionedClusterResource = new ProvisionedCluster("provisionedClusterResource", ProvisionedClusterArgs.builder()
    .identity(ProvisionedClusterIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .resourceGroupName("string")
    .arcAgentAutoUpgradeEnabled(false)
    .arcAgentDesiredVersion("string")
    .azureActiveDirectory(ProvisionedClusterAzureActiveDirectoryArgs.builder()
        .adminGroupObjectIds("string")
        .azureRbacEnabled(false)
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    provisioned_cluster_resource = azure.arckubernetes.ProvisionedCluster("provisionedClusterResource",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    resource_group_name="string",
    arc_agent_auto_upgrade_enabled=False,
    arc_agent_desired_version="string",
    azure_active_directory={
        "admin_group_object_ids": ["string"],
        "azure_rbac_enabled": False,
        "tenant_id": "string",
    },
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const provisionedClusterResource = new azure.arckubernetes.ProvisionedCluster("provisionedClusterResource", {
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    resourceGroupName: "string",
    arcAgentAutoUpgradeEnabled: false,
    arcAgentDesiredVersion: "string",
    azureActiveDirectory: {
        adminGroupObjectIds: ["string"],
        azureRbacEnabled: false,
        tenantId: "string",
    },
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:arckubernetes:ProvisionedCluster
properties:
    arcAgentAutoUpgradeEnabled: false
    arcAgentDesiredVersion: string
    azureActiveDirectory:
        adminGroupObjectIds:
            - string
        azureRbacEnabled: false
        tenantId: string
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string

    ProvisionedCluster Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProvisionedCluster resource accepts the following input properties:

    Identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    ArcAgentAutoUpgradeEnabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    ArcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    AzureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    Location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    Identity ProvisionedClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    ArcAgentAutoUpgradeEnabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    ArcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    AzureActiveDirectory ProvisionedClusterAzureActiveDirectoryArgs
    An azure_active_directory block as defined below.
    Location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    arcAgentAutoUpgradeEnabled Boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion String
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    location String
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name String
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    arcAgentAutoUpgradeEnabled boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    arc_agent_auto_upgrade_enabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arc_agent_desired_version str
    The version of the Arc agents to be installed on the cluster.
    azure_active_directory ProvisionedClusterAzureActiveDirectoryArgs
    An azure_active_directory block as defined below.
    location str
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name str
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    identity Property Map
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    arcAgentAutoUpgradeEnabled Boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion String
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory Property Map
    An azure_active_directory block as defined below.
    location String
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name String
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.

    Outputs

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

    AgentVersion string
    The version of the agent running on the cluster resource.
    Distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    KubernetesVersion string
    The Kubernetes version of the cluster resource.
    Offering string
    The cluster offering.
    TotalCoreCount int
    The number of CPU cores present in the cluster resource.
    TotalNodeCount int
    The number of nodes present in the cluster resource.
    AgentVersion string
    The version of the agent running on the cluster resource.
    Distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    KubernetesVersion string
    The Kubernetes version of the cluster resource.
    Offering string
    The cluster offering.
    TotalCoreCount int
    The number of CPU cores present in the cluster resource.
    TotalNodeCount int
    The number of nodes present in the cluster resource.
    agentVersion String
    The version of the agent running on the cluster resource.
    distribution String
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    infrastructure String
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion String
    The Kubernetes version of the cluster resource.
    offering String
    The cluster offering.
    totalCoreCount Integer
    The number of CPU cores present in the cluster resource.
    totalNodeCount Integer
    The number of nodes present in the cluster resource.
    agentVersion string
    The version of the agent running on the cluster resource.
    distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion string
    The Kubernetes version of the cluster resource.
    offering string
    The cluster offering.
    totalCoreCount number
    The number of CPU cores present in the cluster resource.
    totalNodeCount number
    The number of nodes present in the cluster resource.
    agent_version str
    The version of the agent running on the cluster resource.
    distribution str
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    infrastructure str
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetes_version str
    The Kubernetes version of the cluster resource.
    offering str
    The cluster offering.
    total_core_count int
    The number of CPU cores present in the cluster resource.
    total_node_count int
    The number of nodes present in the cluster resource.
    agentVersion String
    The version of the agent running on the cluster resource.
    distribution String
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    infrastructure String
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion String
    The Kubernetes version of the cluster resource.
    offering String
    The cluster offering.
    totalCoreCount Number
    The number of CPU cores present in the cluster resource.
    totalNodeCount Number
    The number of nodes present in the cluster resource.

    Look up Existing ProvisionedCluster Resource

    Get an existing ProvisionedCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProvisionedClusterState, opts?: CustomResourceOptions): ProvisionedCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_version: Optional[str] = None,
        arc_agent_auto_upgrade_enabled: Optional[bool] = None,
        arc_agent_desired_version: Optional[str] = None,
        azure_active_directory: Optional[ProvisionedClusterAzureActiveDirectoryArgs] = None,
        distribution: Optional[str] = None,
        identity: Optional[ProvisionedClusterIdentityArgs] = None,
        infrastructure: Optional[str] = None,
        kubernetes_version: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        offering: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        total_core_count: Optional[int] = None,
        total_node_count: Optional[int] = None) -> ProvisionedCluster
    func GetProvisionedCluster(ctx *Context, name string, id IDInput, state *ProvisionedClusterState, opts ...ResourceOption) (*ProvisionedCluster, error)
    public static ProvisionedCluster Get(string name, Input<string> id, ProvisionedClusterState? state, CustomResourceOptions? opts = null)
    public static ProvisionedCluster get(String name, Output<String> id, ProvisionedClusterState state, CustomResourceOptions options)
    resources:  _:    type: azure:arckubernetes:ProvisionedCluster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentVersion string
    The version of the agent running on the cluster resource.
    ArcAgentAutoUpgradeEnabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    ArcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    AzureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    Distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    Identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    KubernetesVersion string
    The Kubernetes version of the cluster resource.
    Location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Offering string
    The cluster offering.
    ResourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    TotalCoreCount int
    The number of CPU cores present in the cluster resource.
    TotalNodeCount int
    The number of nodes present in the cluster resource.
    AgentVersion string
    The version of the agent running on the cluster resource.
    ArcAgentAutoUpgradeEnabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    ArcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    AzureActiveDirectory ProvisionedClusterAzureActiveDirectoryArgs
    An azure_active_directory block as defined below.
    Distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    Identity ProvisionedClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    KubernetesVersion string
    The Kubernetes version of the cluster resource.
    Location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Offering string
    The cluster offering.
    ResourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    TotalCoreCount int
    The number of CPU cores present in the cluster resource.
    TotalNodeCount int
    The number of nodes present in the cluster resource.
    agentVersion String
    The version of the agent running on the cluster resource.
    arcAgentAutoUpgradeEnabled Boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion String
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    distribution String
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    infrastructure String
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion String
    The Kubernetes version of the cluster resource.
    location String
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name String
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    offering String
    The cluster offering.
    resourceGroupName String
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    totalCoreCount Integer
    The number of CPU cores present in the cluster resource.
    totalNodeCount Integer
    The number of nodes present in the cluster resource.
    agentVersion string
    The version of the agent running on the cluster resource.
    arcAgentAutoUpgradeEnabled boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion string
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory ProvisionedClusterAzureActiveDirectory
    An azure_active_directory block as defined below.
    distribution string
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentity
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    infrastructure string
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion string
    The Kubernetes version of the cluster resource.
    location string
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name string
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    offering string
    The cluster offering.
    resourceGroupName string
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    totalCoreCount number
    The number of CPU cores present in the cluster resource.
    totalNodeCount number
    The number of nodes present in the cluster resource.
    agent_version str
    The version of the agent running on the cluster resource.
    arc_agent_auto_upgrade_enabled bool
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arc_agent_desired_version str
    The version of the Arc agents to be installed on the cluster.
    azure_active_directory ProvisionedClusterAzureActiveDirectoryArgs
    An azure_active_directory block as defined below.
    distribution str
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    identity ProvisionedClusterIdentityArgs
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    infrastructure str
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetes_version str
    The Kubernetes version of the cluster resource.
    location str
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name str
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    offering str
    The cluster offering.
    resource_group_name str
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    total_core_count int
    The number of CPU cores present in the cluster resource.
    total_node_count int
    The number of nodes present in the cluster resource.
    agentVersion String
    The version of the agent running on the cluster resource.
    arcAgentAutoUpgradeEnabled Boolean
    Whether the Arc agents will be upgraded automatically to the latest version. Defaults to true.
    arcAgentDesiredVersion String
    The version of the Arc agents to be installed on the cluster.
    azureActiveDirectory Property Map
    An azure_active_directory block as defined below.
    distribution String
    The distribution running on this Arc Kubernetes Provisioned Cluster.
    identity Property Map
    An identity block as defined below. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    infrastructure String
    The infrastructure on which the Arc Kubernetes Provisioned Cluster is running on.
    kubernetesVersion String
    The Kubernetes version of the cluster resource.
    location String
    The Azure Region where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    name String
    The name which should be used for this Arc Kubernetes Provisioned Cluster. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    offering String
    The cluster offering.
    resourceGroupName String
    The name of the Resource Group where the Arc Kubernetes Provisioned Cluster should exist. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Arc Kubernetes Provisioned Cluster.
    totalCoreCount Number
    The number of CPU cores present in the cluster resource.
    totalNodeCount Number
    The number of nodes present in the cluster resource.

    Supporting Types

    ProvisionedClusterAzureActiveDirectory, ProvisionedClusterAzureActiveDirectoryArgs

    AdminGroupObjectIds List<string>
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    AzureRbacEnabled bool
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    TenantId string
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.
    AdminGroupObjectIds []string
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    AzureRbacEnabled bool
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    TenantId string
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.
    adminGroupObjectIds List<String>
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    azureRbacEnabled Boolean
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    tenantId String
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.
    adminGroupObjectIds string[]
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    azureRbacEnabled boolean
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    tenantId string
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.
    admin_group_object_ids Sequence[str]
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    azure_rbac_enabled bool
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    tenant_id str
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.
    adminGroupObjectIds List<String>
    A list of IDs of Microsoft Entra ID Groups. All members of the specified Microsoft Entra ID Groups have the cluster administrator access to the Kubernetes cluster.
    azureRbacEnabled Boolean
    Whether to enable Azure RBAC for Kubernetes authorization. Defaults to false.
    tenantId String
    The Tenant ID to use for authentication. If not specified, the Tenant of the Arc Kubernetes Cluster will be used.

    ProvisionedClusterIdentity, ProvisionedClusterIdentityArgs

    Type string
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    The type of the Managed Identity. The only possible value is SystemAssigned. Changing this forces a new Arc Kubernetes Provisioned Cluster to be created.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    Import

    Arc Kubernetes Provisioned Clusters can be imported using the resource id, e.g.

    $ pulumi import azure:arckubernetes/provisionedCluster:ProvisionedCluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/cluster1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure