@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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 Cluster extends pulumi.CustomResource {
/**
* Get an existing Cluster 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): Cluster;
/**
* Returns true if the given object is an instance of Cluster. 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 Cluster;
/**
* The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.
*/
readonly aggregatorOrSingleRackDefinition: pulumi.Output<outputs.networkcloud.RackDefinitionResponse>;
/**
* The settings for the log analytics workspace used for output of logs from this cluster.
*/
readonly analyticsOutputSettings: pulumi.Output<outputs.networkcloud.AnalyticsOutputSettingsResponse | undefined>;
/**
* Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
*/
readonly analyticsWorkspaceId: pulumi.Output<string | undefined>;
/**
* The list of cluster runtime version upgrades available for this cluster.
*/
readonly availableUpgradeVersions: pulumi.Output<outputs.networkcloud.ClusterAvailableUpgradeVersionResponse[]>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The capacity supported by this cluster.
*/
readonly clusterCapacity: pulumi.Output<outputs.networkcloud.ClusterCapacityResponse>;
/**
* The latest heartbeat status between the cluster manager and the cluster.
*/
readonly clusterConnectionStatus: pulumi.Output<string>;
/**
* The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.
*/
readonly clusterExtendedLocation: pulumi.Output<outputs.networkcloud.ExtendedLocationResponse>;
/**
* The customer-provided location information to identify where the cluster resides.
*/
readonly clusterLocation: pulumi.Output<string | undefined>;
/**
* The latest connectivity status between cluster manager and the cluster.
*/
readonly clusterManagerConnectionStatus: pulumi.Output<string>;
/**
* The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.
*/
readonly clusterManagerId: pulumi.Output<string>;
/**
* The service principal to be used by the cluster during Arc Appliance installation.
*/
readonly clusterServicePrincipal: pulumi.Output<outputs.networkcloud.ServicePrincipalInformationResponse | undefined>;
/**
* The type of rack configuration for the cluster.
*/
readonly clusterType: pulumi.Output<string>;
/**
* The current runtime version of the cluster.
*/
readonly clusterVersion: pulumi.Output<string>;
/**
* The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
*/
readonly commandOutputSettings: pulumi.Output<outputs.networkcloud.CommandOutputSettingsResponse | undefined>;
/**
* The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
*/
readonly computeDeploymentThreshold: pulumi.Output<outputs.networkcloud.ValidationThresholdResponse | undefined>;
/**
* The list of rack definitions for the compute racks in a multi-rack
* cluster, or an empty list in a single-rack cluster.
*/
readonly computeRackDefinitions: pulumi.Output<outputs.networkcloud.RackDefinitionResponse[] | undefined>;
/**
* The current detailed status of the cluster.
*/
readonly detailedStatus: pulumi.Output<string>;
/**
* The descriptive message about the detailed status.
*/
readonly detailedStatusMessage: pulumi.Output<string>;
/**
* Resource ETag.
*/
readonly etag: pulumi.Output<string>;
/**
* The extended location of the cluster manager associated with the cluster.
*/
readonly extendedLocation: pulumi.Output<outputs.networkcloud.ExtendedLocationResponse>;
/**
* Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).
*/
readonly hybridAksExtendedLocation: pulumi.Output<outputs.networkcloud.ExtendedLocationResponse>;
/**
* The identity for the resource.
*/
readonly identity: pulumi.Output<outputs.networkcloud.ManagedServiceIdentityResponse | undefined>;
/**
* 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 count of Manual Action Taken (MAT) events that have not been validated.
*/
readonly manualActionCount: pulumi.Output<number>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The resource ID of the Network Fabric associated with the cluster.
*/
readonly networkFabricId: pulumi.Output<string>;
/**
* The provisioning state of the cluster.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The settings for cluster runtime protection.
*/
readonly runtimeProtectionConfiguration: pulumi.Output<outputs.networkcloud.RuntimeProtectionConfigurationResponse | undefined>;
/**
* The configuration for use of a key vault to store secrets for later retrieval by the operator.
*/
readonly secretArchive: pulumi.Output<outputs.networkcloud.ClusterSecretArchiveResponse | undefined>;
/**
* The settings for the secret archive used to hold credentials for the cluster.
*/
readonly secretArchiveSettings: pulumi.Output<outputs.networkcloud.SecretArchiveSettingsResponse | undefined>;
/**
* The support end date of the runtime version of the cluster.
*/
readonly supportExpiryDate: 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>;
/**
* The strategy for updating the cluster.
*/
readonly updateStrategy: pulumi.Output<outputs.networkcloud.ClusterUpdateStrategyResponse | undefined>;
/**
* The settings for how security vulnerability scanning is applied to the cluster.
*/
readonly vulnerabilityScanningSettings: pulumi.Output<outputs.networkcloud.VulnerabilityScanningSettingsResponse | undefined>;
/**
* The list of workload resource IDs that are hosted within this cluster.
*/
readonly workloadResourceIds: pulumi.Output<string[]>;
/**
* Create a Cluster 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: ClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Cluster resource.
*/
export interface ClusterArgs {
/**
* The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.
*/
aggregatorOrSingleRackDefinition: pulumi.Input<inputs.networkcloud.RackDefinitionArgs>;
/**
* The settings for the log analytics workspace used for output of logs from this cluster.
*/
analyticsOutputSettings?: pulumi.Input<inputs.networkcloud.AnalyticsOutputSettingsArgs>;
/**
* Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
*/
analyticsWorkspaceId?: pulumi.Input<string>;
/**
* The customer-provided location information to identify where the cluster resides.
*/
clusterLocation?: pulumi.Input<string>;
/**
* The name of the cluster.
*/
clusterName?: pulumi.Input<string>;
/**
* The service principal to be used by the cluster during Arc Appliance installation.
*/
clusterServicePrincipal?: pulumi.Input<inputs.networkcloud.ServicePrincipalInformationArgs>;
/**
* The type of rack configuration for the cluster.
*/
clusterType: pulumi.Input<string | enums.networkcloud.ClusterType>;
/**
* The current runtime version of the cluster.
*/
clusterVersion: pulumi.Input<string>;
/**
* The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
*/
commandOutputSettings?: pulumi.Input<inputs.networkcloud.CommandOutputSettingsArgs>;
/**
* The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
*/
computeDeploymentThreshold?: pulumi.Input<inputs.networkcloud.ValidationThresholdArgs>;
/**
* The list of rack definitions for the compute racks in a multi-rack
* cluster, or an empty list in a single-rack cluster.
*/
computeRackDefinitions?: pulumi.Input<pulumi.Input<inputs.networkcloud.RackDefinitionArgs>[]>;
/**
* The extended location of the cluster manager associated with the cluster.
*/
extendedLocation: pulumi.Input<inputs.networkcloud.ExtendedLocationArgs>;
/**
* The identity for the resource.
*/
identity?: pulumi.Input<inputs.networkcloud.ManagedServiceIdentityArgs>;
/**
* 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 resource ID of the Network Fabric associated with the cluster.
*/
networkFabricId: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The settings for cluster runtime protection.
*/
runtimeProtectionConfiguration?: pulumi.Input<inputs.networkcloud.RuntimeProtectionConfigurationArgs>;
/**
* The configuration for use of a key vault to store secrets for later retrieval by the operator.
*/
secretArchive?: pulumi.Input<inputs.networkcloud.ClusterSecretArchiveArgs>;
/**
* The settings for the secret archive used to hold credentials for the cluster.
*/
secretArchiveSettings?: pulumi.Input<inputs.networkcloud.SecretArchiveSettingsArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The strategy for updating the cluster.
*/
updateStrategy?: pulumi.Input<inputs.networkcloud.ClusterUpdateStrategyArgs>;
/**
* The settings for how security vulnerability scanning is applied to the cluster.
*/
vulnerabilityScanningSettings?: pulumi.Input<inputs.networkcloud.VulnerabilityScanningSettingsArgs>;
}