@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Uses Azure REST API version 2025-02-01. In version 2.x of the Azure Native provider, it used API version 2023-10-01-preview.
*
* 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 class KubernetesCluster extends pulumi.CustomResource {
/**
* Get an existing KubernetesCluster resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): KubernetesCluster;
/**
* Returns true if the given object is an instance of KubernetesCluster. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is KubernetesCluster;
/**
* The Azure Active Directory Integration properties.
*/
readonly aadConfiguration: pulumi.Output<outputs.networkcloud.AadConfigurationResponse | undefined>;
/**
* The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
*/
readonly administratorConfiguration: pulumi.Output<outputs.networkcloud.AdministratorConfigurationResponse | undefined>;
/**
* The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
*/
readonly attachedNetworkIds: pulumi.Output<string[]>;
/**
* The list of versions that this Kubernetes cluster can be upgraded to.
*/
readonly availableUpgrades: pulumi.Output<outputs.networkcloud.AvailableUpgradeResponse[]>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The resource ID of the Network Cloud cluster.
*/
readonly clusterId: pulumi.Output<string>;
/**
* The resource ID of the connected cluster set up when this Kubernetes cluster is created.
*/
readonly connectedClusterId: pulumi.Output<string>;
/**
* The current running version of Kubernetes on the control plane.
*/
readonly controlPlaneKubernetesVersion: pulumi.Output<string>;
/**
* The defining characteristics of the control plane for this Kubernetes Cluster.
*/
readonly controlPlaneNodeConfiguration: pulumi.Output<outputs.networkcloud.ControlPlaneNodeConfigurationResponse>;
/**
* The current status of the Kubernetes cluster.
*/
readonly detailedStatus: pulumi.Output<string>;
/**
* The descriptive message about the current detailed status.
*/
readonly detailedStatusMessage: pulumi.Output<string>;
/**
* Resource ETag.
*/
readonly etag: pulumi.Output<string>;
/**
* The extended location of the cluster associated with the resource.
*/
readonly extendedLocation: pulumi.Output<outputs.networkcloud.ExtendedLocationResponse>;
/**
* The current feature settings.
*/
readonly featureStatuses: pulumi.Output<outputs.networkcloud.FeatureStatusResponse[]>;
/**
* 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: pulumi.Output<outputs.networkcloud.InitialAgentPoolConfigurationResponse[]>;
/**
* The Kubernetes version for this cluster.
*/
readonly kubernetesVersion: pulumi.Output<string>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The configuration of the managed resource group associated with the resource.
*/
readonly managedResourceGroupConfiguration: pulumi.Output<outputs.networkcloud.ManagedResourceGroupConfigurationResponse | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
*/
readonly networkConfiguration: pulumi.Output<outputs.networkcloud.NetworkConfigurationResponse>;
/**
* The details of the nodes in this cluster.
*/
readonly nodes: pulumi.Output<outputs.networkcloud.KubernetesClusterNodeResponse[]>;
/**
* The provisioning state of the Kubernetes cluster resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.networkcloud.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a KubernetesCluster resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: KubernetesClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a KubernetesCluster resource.
*/
export interface KubernetesClusterArgs {
/**
* The Azure Active Directory Integration properties.
*/
aadConfiguration?: pulumi.Input<inputs.networkcloud.AadConfigurationArgs>;
/**
* The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
*/
administratorConfiguration?: pulumi.Input<inputs.networkcloud.AdministratorConfigurationArgs>;
/**
* The defining characteristics of the control plane for this Kubernetes Cluster.
*/
controlPlaneNodeConfiguration: pulumi.Input<inputs.networkcloud.ControlPlaneNodeConfigurationArgs>;
/**
* The extended location of the cluster associated with the resource.
*/
extendedLocation: pulumi.Input<inputs.networkcloud.ExtendedLocationArgs>;
/**
* 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.
*/
initialAgentPoolConfigurations: pulumi.Input<pulumi.Input<inputs.networkcloud.InitialAgentPoolConfigurationArgs>[]>;
/**
* The name of the Kubernetes cluster.
*/
kubernetesClusterName?: pulumi.Input<string>;
/**
* The Kubernetes version for this cluster.
*/
kubernetesVersion: pulumi.Input<string>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The configuration of the managed resource group associated with the resource.
*/
managedResourceGroupConfiguration?: pulumi.Input<inputs.networkcloud.ManagedResourceGroupConfigurationArgs>;
/**
* The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
*/
networkConfiguration: pulumi.Input<inputs.networkcloud.NetworkConfigurationArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}