Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. kubernetes
  5. getConnectedCluster
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.kubernetes.getConnectedCluster

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. Azure REST API version: 2022-05-01-preview.

Other available API versions: 2022-10-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-07-15-preview, 2024-12-01-preview.

Using getConnectedCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnectedCluster(args: GetConnectedClusterArgs, opts?: InvokeOptions): Promise<GetConnectedClusterResult>
function getConnectedClusterOutput(args: GetConnectedClusterOutputArgs, opts?: InvokeOptions): Output<GetConnectedClusterResult>
Copy
def get_connected_cluster(cluster_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetConnectedClusterResult
def get_connected_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetConnectedClusterResult]
Copy
func LookupConnectedCluster(ctx *Context, args *LookupConnectedClusterArgs, opts ...InvokeOption) (*LookupConnectedClusterResult, error)
func LookupConnectedClusterOutput(ctx *Context, args *LookupConnectedClusterOutputArgs, opts ...InvokeOption) LookupConnectedClusterResultOutput
Copy

> Note: This function is named LookupConnectedCluster in the Go SDK.

public static class GetConnectedCluster 
{
    public static Task<GetConnectedClusterResult> InvokeAsync(GetConnectedClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectedClusterResult> Invoke(GetConnectedClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectedClusterResult> getConnectedCluster(GetConnectedClusterArgs args, InvokeOptions options)
public static Output<GetConnectedClusterResult> getConnectedCluster(GetConnectedClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kubernetes:getConnectedCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kubernetes cluster on which get is called.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kubernetes cluster on which get is called.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kubernetes cluster on which get is called.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kubernetes cluster on which get is called.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kubernetes cluster on which get is called.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kubernetes cluster on which get is called.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getConnectedCluster Result

The following output properties are available:

AgentPublicKeyCertificate string
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
AgentVersion string
Version of the agent running on the connected cluster resource
ConnectivityStatus string
Represents the connectivity status of the connected cluster.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Identity Pulumi.AzureNative.Kubernetes.Outputs.ConnectedClusterIdentityResponse
The identity of the connected cluster.
KubernetesVersion string
The Kubernetes version of the connected cluster resource
LastConnectivityTime string
Time representing the last instance when heart beat was received from the cluster
Location string
The geo-location where the resource lives
ManagedIdentityCertificateExpirationTime string
Expiration time of the managed identity certificate
Name string
The name of the resource
Offering string
Connected cluster offering
SystemData Pulumi.AzureNative.Kubernetes.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource
TotalCoreCount int
Number of CPU cores present in the connected cluster resource
TotalNodeCount int
Number of nodes present in the connected cluster resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Distribution string
The Kubernetes distribution running on this connected cluster.
Infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
PrivateLinkScopeResourceId string
The resource id of the private link scope this connected cluster is assigned to, if any.
PrivateLinkState string
Property which describes the state of private link on a connected cluster resource.
ProvisioningState string
Provisioning state of the connected cluster resource.
Tags Dictionary<string, string>
Resource tags.
AgentPublicKeyCertificate string
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
AgentVersion string
Version of the agent running on the connected cluster resource
ConnectivityStatus string
Represents the connectivity status of the connected cluster.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Identity ConnectedClusterIdentityResponse
The identity of the connected cluster.
KubernetesVersion string
The Kubernetes version of the connected cluster resource
LastConnectivityTime string
Time representing the last instance when heart beat was received from the cluster
Location string
The geo-location where the resource lives
ManagedIdentityCertificateExpirationTime string
Expiration time of the managed identity certificate
Name string
The name of the resource
Offering string
Connected cluster offering
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
TotalCoreCount int
Number of CPU cores present in the connected cluster resource
TotalNodeCount int
Number of nodes present in the connected cluster resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Distribution string
The Kubernetes distribution running on this connected cluster.
Infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
PrivateLinkScopeResourceId string
The resource id of the private link scope this connected cluster is assigned to, if any.
PrivateLinkState string
Property which describes the state of private link on a connected cluster resource.
ProvisioningState string
Provisioning state of the connected cluster resource.
Tags map[string]string
Resource tags.
agentPublicKeyCertificate String
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
agentVersion String
Version of the agent running on the connected cluster resource
connectivityStatus String
Represents the connectivity status of the connected cluster.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity ConnectedClusterIdentityResponse
The identity of the connected cluster.
kubernetesVersion String
The Kubernetes version of the connected cluster resource
lastConnectivityTime String
Time representing the last instance when heart beat was received from the cluster
location String
The geo-location where the resource lives
managedIdentityCertificateExpirationTime String
Expiration time of the managed identity certificate
name String
The name of the resource
offering String
Connected cluster offering
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
totalCoreCount Integer
Number of CPU cores present in the connected cluster resource
totalNodeCount Integer
Number of nodes present in the connected cluster resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
distribution String
The Kubernetes distribution running on this connected cluster.
infrastructure String
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
privateLinkScopeResourceId String
The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState String
Property which describes the state of private link on a connected cluster resource.
provisioningState String
Provisioning state of the connected cluster resource.
tags Map<String,String>
Resource tags.
agentPublicKeyCertificate string
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
agentVersion string
Version of the agent running on the connected cluster resource
connectivityStatus string
Represents the connectivity status of the connected cluster.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity ConnectedClusterIdentityResponse
The identity of the connected cluster.
kubernetesVersion string
The Kubernetes version of the connected cluster resource
lastConnectivityTime string
Time representing the last instance when heart beat was received from the cluster
location string
The geo-location where the resource lives
managedIdentityCertificateExpirationTime string
Expiration time of the managed identity certificate
name string
The name of the resource
offering string
Connected cluster offering
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
totalCoreCount number
Number of CPU cores present in the connected cluster resource
totalNodeCount number
Number of nodes present in the connected cluster resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
distribution string
The Kubernetes distribution running on this connected cluster.
infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
privateLinkScopeResourceId string
The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState string
Property which describes the state of private link on a connected cluster resource.
provisioningState string
Provisioning state of the connected cluster resource.
tags {[key: string]: string}
Resource tags.
agent_public_key_certificate str
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
agent_version str
Version of the agent running on the connected cluster resource
connectivity_status str
Represents the connectivity status of the connected cluster.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity ConnectedClusterIdentityResponse
The identity of the connected cluster.
kubernetes_version str
The Kubernetes version of the connected cluster resource
last_connectivity_time str
Time representing the last instance when heart beat was received from the cluster
location str
The geo-location where the resource lives
managed_identity_certificate_expiration_time str
Expiration time of the managed identity certificate
name str
The name of the resource
offering str
Connected cluster offering
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource
total_core_count int
Number of CPU cores present in the connected cluster resource
total_node_count int
Number of nodes present in the connected cluster resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
distribution str
The Kubernetes distribution running on this connected cluster.
infrastructure str
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
private_link_scope_resource_id str
The resource id of the private link scope this connected cluster is assigned to, if any.
private_link_state str
Property which describes the state of private link on a connected cluster resource.
provisioning_state str
Provisioning state of the connected cluster resource.
tags Mapping[str, str]
Resource tags.
agentPublicKeyCertificate String
Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
agentVersion String
Version of the agent running on the connected cluster resource
connectivityStatus String
Represents the connectivity status of the connected cluster.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity Property Map
The identity of the connected cluster.
kubernetesVersion String
The Kubernetes version of the connected cluster resource
lastConnectivityTime String
Time representing the last instance when heart beat was received from the cluster
location String
The geo-location where the resource lives
managedIdentityCertificateExpirationTime String
Expiration time of the managed identity certificate
name String
The name of the resource
offering String
Connected cluster offering
systemData Property Map
Metadata pertaining to creation and last modification of the resource
totalCoreCount Number
Number of CPU cores present in the connected cluster resource
totalNodeCount Number
Number of nodes present in the connected cluster resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
distribution String
The Kubernetes distribution running on this connected cluster.
infrastructure String
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
privateLinkScopeResourceId String
The resource id of the private link scope this connected cluster is assigned to, if any.
privateLinkState String
Property which describes the state of private link on a connected cluster resource.
provisioningState String
Provisioning state of the connected cluster resource.
tags Map<String>
Resource tags.

Supporting Types

ConnectedClusterIdentityResponse

PrincipalId This property is required. string
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
Type This property is required. string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
PrincipalId This property is required. string
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
Type This property is required. string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
principalId This property is required. String
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
type This property is required. String
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
principalId This property is required. string
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
type This property is required. string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
principal_id This property is required. str
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
type This property is required. str
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
principalId This property is required. String
The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
type This property is required. String
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource modification (UTC).
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native