@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a cluster pool.
*
* Uses Azure REST API version 2024-05-01-preview.
*
* Other available API versions: 2023-06-01-preview, 2023-11-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native hdinsight [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getClusterPool(args: GetClusterPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterPoolResult>;
export interface GetClusterPoolArgs {
/**
* The name of the cluster pool.
*/
clusterPoolName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Cluster pool.
*/
export interface GetClusterPoolResult {
/**
* Properties of underlying AKS cluster.
*/
readonly aksClusterProfile: outputs.hdinsight.ClusterPoolResourcePropertiesResponseAksClusterProfile;
/**
* A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}
*/
readonly aksManagedResourceGroupName: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* CLuster pool profile.
*/
readonly clusterPoolProfile?: outputs.hdinsight.ClusterPoolResourcePropertiesResponseClusterPoolProfile;
/**
* CLuster pool compute profile.
*/
readonly computeProfile: outputs.hdinsight.ClusterPoolResourcePropertiesResponseComputeProfile;
/**
* A unique id generated by the RP to identify the resource.
*/
readonly deploymentId: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* Cluster pool log analytics profile to enable OMS agent for AKS cluster.
*/
readonly logAnalyticsProfile?: outputs.hdinsight.ClusterPoolResourcePropertiesResponseLogAnalyticsProfile;
/**
* A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.
*/
readonly managedResourceGroupName?: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Cluster pool network profile.
*/
readonly networkProfile?: outputs.hdinsight.ClusterPoolResourcePropertiesResponseNetworkProfile;
/**
* Provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* Business status of the resource.
*/
readonly status: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.hdinsight.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;
}
/**
* Gets a cluster pool.
*
* Uses Azure REST API version 2024-05-01-preview.
*
* Other available API versions: 2023-06-01-preview, 2023-11-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native hdinsight [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getClusterPoolOutput(args: GetClusterPoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterPoolResult>;
export interface GetClusterPoolOutputArgs {
/**
* The name of the cluster pool.
*/
clusterPoolName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}