azure logo
Azure Classic v5.43.0, May 6 23

azure.arckubernetes.Cluster

Explore with Pulumi AI

Import

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

 $ pulumi import azure:arckubernetes/cluster:Cluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            agent_public_key_certificate: Optional[str] = None,
            identity: Optional[ClusterIdentityArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: azure:arckubernetes:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterArgs
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 ClusterArgs
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 ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cluster 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 Cluster resource accepts the following input properties:

AgentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

Identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

ResourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

AgentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

Identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

ResourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

Tags map[string]string

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

agentPublicKeyCertificate String

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

location String

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name String

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

agentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

resourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

agent_public_key_certificate str

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

resource_group_name str

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

location str

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name str

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

agentPublicKeyCertificate String

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

identity Property Map

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

resourceGroupName String

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

location String

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name String

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Map<String>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

Outputs

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

AgentVersion string

Version of the agent running on the cluster resource.

Distribution string

The distribution running on this Arc Kubernetes Cluster.

Id string

The provider-assigned unique ID for this managed resource.

Infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

KubernetesVersion string

The Kubernetes version of the cluster resource.

Offering string

The cluster offering.

TotalCoreCount int

Number of CPU cores present in the cluster resource.

TotalNodeCount int

Number of nodes present in the cluster resource.

AgentVersion string

Version of the agent running on the cluster resource.

Distribution string

The distribution running on this Arc Kubernetes Cluster.

Id string

The provider-assigned unique ID for this managed resource.

Infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

KubernetesVersion string

The Kubernetes version of the cluster resource.

Offering string

The cluster offering.

TotalCoreCount int

Number of CPU cores present in the cluster resource.

TotalNodeCount int

Number of nodes present in the cluster resource.

agentVersion String

Version of the agent running on the cluster resource.

distribution String

The distribution running on this Arc Kubernetes Cluster.

id String

The provider-assigned unique ID for this managed resource.

infrastructure String

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion String

The Kubernetes version of the cluster resource.

offering String

The cluster offering.

totalCoreCount Integer

Number of CPU cores present in the cluster resource.

totalNodeCount Integer

Number of nodes present in the cluster resource.

agentVersion string

Version of the agent running on the cluster resource.

distribution string

The distribution running on this Arc Kubernetes Cluster.

id string

The provider-assigned unique ID for this managed resource.

infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion string

The Kubernetes version of the cluster resource.

offering string

The cluster offering.

totalCoreCount number

Number of CPU cores present in the cluster resource.

totalNodeCount number

Number of nodes present in the cluster resource.

agent_version str

Version of the agent running on the cluster resource.

distribution str

The distribution running on this Arc Kubernetes Cluster.

id str

The provider-assigned unique ID for this managed resource.

infrastructure str

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetes_version str

The Kubernetes version of the cluster resource.

offering str

The cluster offering.

total_core_count int

Number of CPU cores present in the cluster resource.

total_node_count int

Number of nodes present in the cluster resource.

agentVersion String

Version of the agent running on the cluster resource.

distribution String

The distribution running on this Arc Kubernetes Cluster.

id String

The provider-assigned unique ID for this managed resource.

infrastructure String

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion String

The Kubernetes version of the cluster resource.

offering String

The cluster offering.

totalCoreCount Number

Number of CPU cores present in the cluster resource.

totalNodeCount Number

Number of nodes present in the cluster resource.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_public_key_certificate: Optional[str] = None,
        agent_version: Optional[str] = None,
        distribution: Optional[str] = None,
        identity: Optional[ClusterIdentityArgs] = 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) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
AgentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

AgentVersion string

Version of the agent running on the cluster resource.

Distribution string

The distribution running on this Arc Kubernetes Cluster.

Identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

Infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

KubernetesVersion string

The Kubernetes version of the cluster resource.

Location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

Offering string

The cluster offering.

ResourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

TotalCoreCount int

Number of CPU cores present in the cluster resource.

TotalNodeCount int

Number of nodes present in the cluster resource.

AgentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

AgentVersion string

Version of the agent running on the cluster resource.

Distribution string

The distribution running on this Arc Kubernetes Cluster.

Identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

Infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

KubernetesVersion string

The Kubernetes version of the cluster resource.

Location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

Offering string

The cluster offering.

ResourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

Tags map[string]string

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

TotalCoreCount int

Number of CPU cores present in the cluster resource.

TotalNodeCount int

Number of nodes present in the cluster resource.

agentPublicKeyCertificate String

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

agentVersion String

Version of the agent running on the cluster resource.

distribution String

The distribution running on this Arc Kubernetes Cluster.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

infrastructure String

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion String

The Kubernetes version of the cluster resource.

location String

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name String

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

offering String

The cluster offering.

resourceGroupName String

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

totalCoreCount Integer

Number of CPU cores present in the cluster resource.

totalNodeCount Integer

Number of nodes present in the cluster resource.

agentPublicKeyCertificate string

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

agentVersion string

Version of the agent running on the cluster resource.

distribution string

The distribution running on this Arc Kubernetes Cluster.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

infrastructure string

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion string

The Kubernetes version of the cluster resource.

location string

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name string

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

offering string

The cluster offering.

resourceGroupName string

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

totalCoreCount number

Number of CPU cores present in the cluster resource.

totalNodeCount number

Number of nodes present in the cluster resource.

agent_public_key_certificate str

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

agent_version str

Version of the agent running on the cluster resource.

distribution str

The distribution running on this Arc Kubernetes Cluster.

identity ClusterIdentityArgs

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

infrastructure str

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetes_version str

The Kubernetes version of the cluster resource.

location str

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name str

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

offering str

The cluster offering.

resource_group_name str

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

total_core_count int

Number of CPU cores present in the cluster resource.

total_node_count int

Number of nodes present in the cluster resource.

agentPublicKeyCertificate String

Specifies the base64-encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Changing this forces a new Arc Kubernetes Cluster to be created.

agentVersion String

Version of the agent running on the cluster resource.

distribution String

The distribution running on this Arc Kubernetes Cluster.

identity Property Map

An identity block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.

infrastructure String

The infrastructure on which the Arc Kubernetes Cluster is running on.

kubernetesVersion String

The Kubernetes version of the cluster resource.

location String

Specifies the Azure Region where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

name String

Specifies the name which should be used for this Arc Kubernetes Cluster. Changing this forces a new Arc Kubernetes Cluster to be created.

offering String

The cluster offering.

resourceGroupName String

Specifies the name of the Resource Group where the Arc Kubernetes Cluster should exist. Changing this forces a new Arc Kubernetes Cluster to be created.

tags Map<String>

A mapping of tags which should be assigned to the Arc Kubernetes Cluster.

totalCoreCount Number

Number of CPU cores present in the cluster resource.

totalNodeCount Number

Number of nodes present in the cluster resource.

Supporting Types

ClusterIdentity

Type string

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

type String

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

type string

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type str

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

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

Specifies the type of Managed Service Identity assigned to this Arc Kubernetes Cluster. At this time the only possible value is SystemAssigned.

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.