@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get properties of the provided the Kubernetes cluster.
*
* Uses Azure REST API version 2025-02-01.
*
* Other available API versions: 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native networkcloud [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetKubernetesClusterResult>;
export interface GetKubernetesClusterArgs {
/**
* The name of the Kubernetes cluster.
*/
kubernetesClusterName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
export interface GetKubernetesClusterResult {
/**
* The Azure Active Directory Integration properties.
*/
readonly aadConfiguration?: outputs.networkcloud.AadConfigurationResponse;
/**
* The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
*/
readonly administratorConfiguration?: outputs.networkcloud.AdministratorConfigurationResponse;
/**
* The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
*/
readonly attachedNetworkIds: string[];
/**
* The list of versions that this Kubernetes cluster can be upgraded to.
*/
readonly availableUpgrades: outputs.networkcloud.AvailableUpgradeResponse[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The resource ID of the Network Cloud cluster.
*/
readonly clusterId: string;
/**
* The resource ID of the connected cluster set up when this Kubernetes cluster is created.
*/
readonly connectedClusterId: string;
/**
* The current running version of Kubernetes on the control plane.
*/
readonly controlPlaneKubernetesVersion: string;
/**
* The defining characteristics of the control plane for this Kubernetes Cluster.
*/
readonly controlPlaneNodeConfiguration: outputs.networkcloud.ControlPlaneNodeConfigurationResponse;
/**
* The current status of the Kubernetes cluster.
*/
readonly detailedStatus: string;
/**
* The descriptive message about the current detailed status.
*/
readonly detailedStatusMessage: string;
/**
* Resource ETag.
*/
readonly etag: string;
/**
* The extended location of the cluster associated with the resource.
*/
readonly extendedLocation: outputs.networkcloud.ExtendedLocationResponse;
/**
* The current feature settings.
*/
readonly featureStatuses: outputs.networkcloud.FeatureStatusResponse[];
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.
*/
readonly initialAgentPoolConfigurations: outputs.networkcloud.InitialAgentPoolConfigurationResponse[];
/**
* The Kubernetes version for this cluster.
*/
readonly kubernetesVersion: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The configuration of the managed resource group associated with the resource.
*/
readonly managedResourceGroupConfiguration?: outputs.networkcloud.ManagedResourceGroupConfigurationResponse;
/**
* The name of the resource
*/
readonly name: string;
/**
* The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
*/
readonly networkConfiguration: outputs.networkcloud.NetworkConfigurationResponse;
/**
* The details of the nodes in this cluster.
*/
readonly nodes: outputs.networkcloud.KubernetesClusterNodeResponse[];
/**
* The provisioning state of the Kubernetes cluster resource.
*/
readonly provisioningState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.networkcloud.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Get properties of the provided the Kubernetes cluster.
*
* Uses Azure REST API version 2025-02-01.
*
* Other available API versions: 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native networkcloud [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getKubernetesClusterOutput(args: GetKubernetesClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKubernetesClusterResult>;
export interface GetKubernetesClusterOutputArgs {
/**
* The name of the Kubernetes cluster.
*/
kubernetesClusterName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}