Azure Classic v5.43.0, May 6 23
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:
- Agent
Public stringKey Certificate 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
Cluster
Identity Args An
identity
block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.- Resource
Group stringName 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.
- Dictionary<string, string>
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- Agent
Public stringKey Certificate 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
Cluster
Identity Args An
identity
block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.- Resource
Group stringName 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.
- map[string]string
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- agent
Public StringKey Certificate 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
Cluster
Identity Args An
identity
block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.- resource
Group StringName 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.
- Map<String,String>
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- agent
Public stringKey Certificate 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
Cluster
Identity Args An
identity
block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.- resource
Group stringName 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.
- {[key: string]: string}
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- agent_
public_ strkey_ certificate 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
Cluster
Identity Args An
identity
block as defined below. Changing this forces a new Arc Kubernetes Cluster to be created.- resource_
group_ strname 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.
- Mapping[str, str]
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- agent
Public StringKey Certificate 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.- resource
Group StringName 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.
- 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:
- Agent
Version 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.
- Kubernetes
Version string The Kubernetes version of the cluster resource.
- Offering string
The cluster offering.
- Total
Core intCount Number of CPU cores present in the cluster resource.
- Total
Node intCount Number of nodes present in the cluster resource.
- Agent
Version 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.
- Kubernetes
Version string The Kubernetes version of the cluster resource.
- Offering string
The cluster offering.
- Total
Core intCount Number of CPU cores present in the cluster resource.
- Total
Node intCount Number of nodes present in the cluster resource.
- agent
Version 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.
- kubernetes
Version String The Kubernetes version of the cluster resource.
- offering String
The cluster offering.
- total
Core IntegerCount Number of CPU cores present in the cluster resource.
- total
Node IntegerCount Number of nodes present in the cluster resource.
- agent
Version 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.
- kubernetes
Version string The Kubernetes version of the cluster resource.
- offering string
The cluster offering.
- total
Core numberCount Number of CPU cores present in the cluster resource.
- total
Node numberCount 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_ intcount Number of CPU cores present in the cluster resource.
- total_
node_ intcount Number of nodes present in the cluster resource.
- agent
Version 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.
- kubernetes
Version String The Kubernetes version of the cluster resource.
- offering String
The cluster offering.
- total
Core NumberCount Number of CPU cores present in the cluster resource.
- total
Node NumberCount 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.
- Agent
Public stringKey Certificate 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 string Version of the agent running on the cluster resource.
- Distribution string
The distribution running on this Arc Kubernetes Cluster.
- Identity
Cluster
Identity Args 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.
- Kubernetes
Version 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.
- Resource
Group stringName 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.
- Dictionary<string, string>
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- Total
Core intCount Number of CPU cores present in the cluster resource.
- Total
Node intCount Number of nodes present in the cluster resource.
- Agent
Public stringKey Certificate 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 string Version of the agent running on the cluster resource.
- Distribution string
The distribution running on this Arc Kubernetes Cluster.
- Identity
Cluster
Identity Args 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.
- Kubernetes
Version 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.
- Resource
Group stringName 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.
- map[string]string
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- Total
Core intCount Number of CPU cores present in the cluster resource.
- Total
Node intCount Number of nodes present in the cluster resource.
- agent
Public StringKey Certificate 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 String Version of the agent running on the cluster resource.
- distribution String
The distribution running on this Arc Kubernetes Cluster.
- identity
Cluster
Identity Args 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.
- kubernetes
Version 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.
- resource
Group StringName 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.
- Map<String,String>
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- total
Core IntegerCount Number of CPU cores present in the cluster resource.
- total
Node IntegerCount Number of nodes present in the cluster resource.
- agent
Public stringKey Certificate 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 string Version of the agent running on the cluster resource.
- distribution string
The distribution running on this Arc Kubernetes Cluster.
- identity
Cluster
Identity Args 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.
- kubernetes
Version 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.
- resource
Group stringName 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.
- {[key: string]: string}
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- total
Core numberCount Number of CPU cores present in the cluster resource.
- total
Node numberCount Number of nodes present in the cluster resource.
- agent_
public_ strkey_ certificate 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
Cluster
Identity Args 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_ strname 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.
- Mapping[str, str]
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- total_
core_ intcount Number of CPU cores present in the cluster resource.
- total_
node_ intcount Number of nodes present in the cluster resource.
- agent
Public StringKey Certificate 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 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.
- kubernetes
Version 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.
- resource
Group StringName 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.
- Map<String>
A mapping of tags which should be assigned to the Arc Kubernetes Cluster.
- total
Core NumberCount Number of CPU cores present in the cluster resource.
- total
Node NumberCount 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
.- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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
.- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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
.- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id 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
.- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id 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
.- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id 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.