@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
*
* Uses Azure REST API version 2024-02-01-preview.
*
* Other available API versions: 2021-04-01-preview, 2021-10-01, 2022-05-01-preview, 2022-10-01-preview, 2023-11-01-preview, 2024-01-01, 2024-06-01-preview, 2024-07-01-preview, 2024-07-15-preview, 2024-12-01-preview, 2025-08-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kubernetes [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConnectedCluster(args: GetConnectedClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectedClusterResult>;
export interface GetConnectedClusterArgs {
/**
* The name of the Kubernetes cluster on which get is called.
*/
clusterName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Represents a connected cluster.
*/
export interface GetConnectedClusterResult {
/**
* AAD profile for the connected cluster.
*/
readonly aadProfile?: outputs.kubernetes.AadProfileResponse;
/**
* Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
*/
readonly agentPublicKeyCertificate: string;
/**
* Version of the agent running on the connected cluster resource
*/
readonly agentVersion: string;
/**
* Arc agentry configuration for the provisioned cluster.
*/
readonly arcAgentProfile?: outputs.kubernetes.ArcAgentProfileResponse;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Indicates whether Azure Hybrid Benefit is opted in
*/
readonly azureHybridBenefit?: string;
/**
* Represents the connectivity status of the connected cluster.
*/
readonly connectivityStatus: string;
/**
* The Kubernetes distribution running on this connected cluster.
*/
readonly distribution?: string;
/**
* The Kubernetes distribution version on this connected cluster.
*/
readonly distributionVersion?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The identity of the connected cluster.
*/
readonly identity: outputs.kubernetes.ConnectedClusterIdentityResponse;
/**
* The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
*/
readonly infrastructure?: string;
/**
* The kind of connected cluster.
*/
readonly kind?: string;
/**
* The Kubernetes version of the connected cluster resource
*/
readonly kubernetesVersion: string;
/**
* Time representing the last instance when heart beat was received from the cluster
*/
readonly lastConnectivityTime: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* Expiration time of the managed identity certificate
*/
readonly managedIdentityCertificateExpirationTime: string;
/**
* More properties related to the Connected Cluster
*/
readonly miscellaneousProperties: {
[key: string]: string;
};
/**
* The name of the resource
*/
readonly name: string;
/**
* Connected cluster offering
*/
readonly offering: string;
/**
* The resource id of the private link scope this connected cluster is assigned to, if any.
*/
readonly privateLinkScopeResourceId?: string;
/**
* Property which describes the state of private link on a connected cluster resource.
*/
readonly privateLinkState?: string;
/**
* Provisioning state of the connected cluster resource.
*/
readonly provisioningState?: string;
/**
* Metadata pertaining to creation and last modification of the resource
*/
readonly systemData: outputs.kubernetes.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Number of CPU cores present in the connected cluster resource
*/
readonly totalCoreCount: number;
/**
* Number of nodes present in the connected cluster resource
*/
readonly totalNodeCount: number;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
*
* Uses Azure REST API version 2024-02-01-preview.
*
* Other available API versions: 2021-04-01-preview, 2021-10-01, 2022-05-01-preview, 2022-10-01-preview, 2023-11-01-preview, 2024-01-01, 2024-06-01-preview, 2024-07-01-preview, 2024-07-15-preview, 2024-12-01-preview, 2025-08-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kubernetes [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConnectedClusterOutput(args: GetConnectedClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectedClusterResult>;
export interface GetConnectedClusterOutputArgs {
/**
* The name of the Kubernetes cluster on which get is called.
*/
clusterName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}