Azure Native v2.9.0, Sep 27 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.hdinsight.getClusterPool

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

Using getClusterPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getClusterPool(args: GetClusterPoolArgs, opts?: InvokeOptions): Promise<GetClusterPoolResult>
function getClusterPoolOutput(args: GetClusterPoolOutputArgs, opts?: InvokeOptions): Output<GetClusterPoolResult>

def get_cluster_pool(cluster_pool_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetClusterPoolResult
def get_cluster_pool_output(cluster_pool_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetClusterPoolResult]

func LookupClusterPool(ctx *Context, args *LookupClusterPoolArgs, opts ...InvokeOption) (*LookupClusterPoolResult, error)
func LookupClusterPoolOutput(ctx *Context, args *LookupClusterPoolOutputArgs, opts ...InvokeOption) LookupClusterPoolResultOutput

> Note: This function is named LookupClusterPool in the Go SDK.

public static class GetClusterPool 
{
    public static Task<GetClusterPoolResult> InvokeAsync(GetClusterPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterPoolResult> Invoke(GetClusterPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterPoolResult> getClusterPool(GetClusterPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:hdinsight:getClusterPool
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterPoolName string: The name of the cluster pool.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterPoolName string: The name of the cluster pool.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterPoolName String: The name of the cluster pool.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterPoolName string: The name of the cluster pool.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_pool_name str: The name of the cluster pool.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterPoolName String: The name of the cluster pool.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getClusterPool Result

The following output properties are available:

AksClusterProfile Pulumi.AzureNative.HDInsight.Outputs.ClusterPoolResourcePropertiesResponseAksClusterProfile: Properties of underlying AKS cluster.
AksManagedResourceGroupName string: 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}
ComputeProfile Pulumi.AzureNative.HDInsight.Outputs.ClusterPoolResourcePropertiesResponseComputeProfile: CLuster pool compute profile.
DeploymentId string: A unique id generated by the RP to identify the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: Provisioning state of the resource.
Status string: Business status of the resource.
SystemData Pulumi.AzureNative.HDInsight.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClusterPoolProfile Pulumi.AzureNative.HDInsight.Outputs.ClusterPoolResourcePropertiesResponseClusterPoolProfile: CLuster pool profile.
LogAnalyticsProfile Pulumi.AzureNative.HDInsight.Outputs.ClusterPoolResourcePropertiesResponseLogAnalyticsProfile: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
ManagedResourceGroupName string: 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.
NetworkProfile Pulumi.AzureNative.HDInsight.Outputs.ClusterPoolResourcePropertiesResponseNetworkProfile: Cluster pool network profile.
Tags Dictionary<string, string>: Resource tags.

AksClusterProfile ClusterPoolResourcePropertiesResponseAksClusterProfile: Properties of underlying AKS cluster.
AksManagedResourceGroupName string: 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}
ComputeProfile ClusterPoolResourcePropertiesResponseComputeProfile: CLuster pool compute profile.
DeploymentId string: A unique id generated by the RP to identify the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
ProvisioningState string: Provisioning state of the resource.
Status string: Business status of the resource.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClusterPoolProfile ClusterPoolResourcePropertiesResponseClusterPoolProfile: CLuster pool profile.
LogAnalyticsProfile ClusterPoolResourcePropertiesResponseLogAnalyticsProfile: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
ManagedResourceGroupName string: 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.
NetworkProfile ClusterPoolResourcePropertiesResponseNetworkProfile: Cluster pool network profile.
Tags map[string]string: Resource tags.

aksClusterProfile ClusterPoolResourcePropertiesResponseAksClusterProfile: Properties of underlying AKS cluster.
aksManagedResourceGroupName String: 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}
computeProfile ClusterPoolResourcePropertiesResponseComputeProfile: CLuster pool compute profile.
deploymentId String: A unique id generated by the RP to identify the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: Provisioning state of the resource.
status String: Business status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clusterPoolProfile ClusterPoolResourcePropertiesResponseClusterPoolProfile: CLuster pool profile.
logAnalyticsProfile ClusterPoolResourcePropertiesResponseLogAnalyticsProfile: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
managedResourceGroupName String: 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.
networkProfile ClusterPoolResourcePropertiesResponseNetworkProfile: Cluster pool network profile.
tags Map<String,String>: Resource tags.

aksClusterProfile ClusterPoolResourcePropertiesResponseAksClusterProfile: Properties of underlying AKS cluster.
aksManagedResourceGroupName string: 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}
computeProfile ClusterPoolResourcePropertiesResponseComputeProfile: CLuster pool compute profile.
deploymentId string: A unique id generated by the RP to identify the resource.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string: The geo-location where the resource lives
name string: The name of the resource
provisioningState string: Provisioning state of the resource.
status string: Business status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clusterPoolProfile ClusterPoolResourcePropertiesResponseClusterPoolProfile: CLuster pool profile.
logAnalyticsProfile ClusterPoolResourcePropertiesResponseLogAnalyticsProfile: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
managedResourceGroupName string: 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.
networkProfile ClusterPoolResourcePropertiesResponseNetworkProfile: Cluster pool network profile.
tags {[key: string]: string}: Resource tags.

aks_cluster_profile ClusterPoolResourcePropertiesResponseAksClusterProfile: Properties of underlying AKS cluster.
aks_managed_resource_group_name str: 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}
compute_profile ClusterPoolResourcePropertiesResponseComputeProfile: CLuster pool compute profile.
deployment_id str: A unique id generated by the RP to identify the resource.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str: The geo-location where the resource lives
name str: The name of the resource
provisioning_state str: Provisioning state of the resource.
status str: Business status of the resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
cluster_pool_profile ClusterPoolResourcePropertiesResponseClusterPoolProfile: CLuster pool profile.
log_analytics_profile ClusterPoolResourcePropertiesResponseLogAnalyticsProfile: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
managed_resource_group_name str: 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.
network_profile ClusterPoolResourcePropertiesResponseNetworkProfile: Cluster pool network profile.
tags Mapping[str, str]: Resource tags.

aksClusterProfile Property Map: Properties of underlying AKS cluster.
aksManagedResourceGroupName String: 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}
computeProfile Property Map: CLuster pool compute profile.
deploymentId String: A unique id generated by the RP to identify the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
provisioningState String: Provisioning state of the resource.
status String: Business status of the resource.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clusterPoolProfile Property Map: CLuster pool profile.
logAnalyticsProfile Property Map: Cluster pool log analytics profile to enable OMS agent for AKS cluster.
managedResourceGroupName String: 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.
networkProfile Property Map: Cluster pool network profile.
tags Map<String>: Resource tags.

Supporting Types

AksClusterProfileResponseAksClusterAgentPoolIdentityProfile

MsiClientId string: ClientId of the MSI.
MsiObjectId string: ObjectId of the MSI.
MsiResourceId string: ResourceId of the MSI.

MsiClientId string: ClientId of the MSI.
MsiObjectId string: ObjectId of the MSI.
MsiResourceId string: ResourceId of the MSI.

msiClientId String: ClientId of the MSI.
msiObjectId String: ObjectId of the MSI.
msiResourceId String: ResourceId of the MSI.

msiClientId string: ClientId of the MSI.
msiObjectId string: ObjectId of the MSI.
msiResourceId string: ResourceId of the MSI.

msi_client_id str: ClientId of the MSI.
msi_object_id str: ObjectId of the MSI.
msi_resource_id str: ResourceId of the MSI.

msiClientId String: ClientId of the MSI.
msiObjectId String: ObjectId of the MSI.
msiResourceId String: ResourceId of the MSI.

ClusterPoolResourcePropertiesResponseAksClusterProfile

AksVersion string: AKS control plane and default node pool version of this ClusterPool
AksClusterAgentPoolIdentityProfile Pulumi.AzureNative.HDInsight.Inputs.AksClusterProfileResponseAksClusterAgentPoolIdentityProfile: Identity properties of the AKS cluster agentpool MSI
AksClusterResourceId string: ARM Resource ID of the AKS cluster

AksVersion string: AKS control plane and default node pool version of this ClusterPool
AksClusterAgentPoolIdentityProfile AksClusterProfileResponseAksClusterAgentPoolIdentityProfile: Identity properties of the AKS cluster agentpool MSI
AksClusterResourceId string: ARM Resource ID of the AKS cluster

aksVersion String: AKS control plane and default node pool version of this ClusterPool
aksClusterAgentPoolIdentityProfile AksClusterProfileResponseAksClusterAgentPoolIdentityProfile: Identity properties of the AKS cluster agentpool MSI
aksClusterResourceId String: ARM Resource ID of the AKS cluster

aksVersion string: AKS control plane and default node pool version of this ClusterPool
aksClusterAgentPoolIdentityProfile AksClusterProfileResponseAksClusterAgentPoolIdentityProfile: Identity properties of the AKS cluster agentpool MSI
aksClusterResourceId string: ARM Resource ID of the AKS cluster

aks_version str: AKS control plane and default node pool version of this ClusterPool
aks_cluster_agent_pool_identity_profile AksClusterProfileResponseAksClusterAgentPoolIdentityProfile: Identity properties of the AKS cluster agentpool MSI
aks_cluster_resource_id str: ARM Resource ID of the AKS cluster

aksVersion String: AKS control plane and default node pool version of this ClusterPool
aksClusterAgentPoolIdentityProfile Property Map: Identity properties of the AKS cluster agentpool MSI
aksClusterResourceId String: ARM Resource ID of the AKS cluster

ClusterPoolResourcePropertiesResponseClusterPoolProfile

ClusterPoolVersion string: Cluster pool version is a 2-part version.

ClusterPoolVersion string: Cluster pool version is a 2-part version.

clusterPoolVersion String: Cluster pool version is a 2-part version.

clusterPoolVersion string: Cluster pool version is a 2-part version.

cluster_pool_version str: Cluster pool version is a 2-part version.

clusterPoolVersion String: Cluster pool version is a 2-part version.

ClusterPoolResourcePropertiesResponseComputeProfile

Count int: The number of virtual machines.
VmSize string: The virtual machine SKU.

Count int: The number of virtual machines.
VmSize string: The virtual machine SKU.

count Integer: The number of virtual machines.
vmSize String: The virtual machine SKU.

count number: The number of virtual machines.
vmSize string: The virtual machine SKU.

count int: The number of virtual machines.
vm_size str: The virtual machine SKU.

count Number: The number of virtual machines.
vmSize String: The virtual machine SKU.

ClusterPoolResourcePropertiesResponseLogAnalyticsProfile

Enabled bool: True if log analytics is enabled for cluster pool, otherwise false.
WorkspaceId string: Log analytics workspace to associate with the OMS agent.

Enabled bool: True if log analytics is enabled for cluster pool, otherwise false.
WorkspaceId string: Log analytics workspace to associate with the OMS agent.

enabled Boolean: True if log analytics is enabled for cluster pool, otherwise false.
workspaceId String: Log analytics workspace to associate with the OMS agent.

enabled boolean: True if log analytics is enabled for cluster pool, otherwise false.
workspaceId string: Log analytics workspace to associate with the OMS agent.

enabled bool: True if log analytics is enabled for cluster pool, otherwise false.
workspace_id str: Log analytics workspace to associate with the OMS agent.

enabled Boolean: True if log analytics is enabled for cluster pool, otherwise false.
workspaceId String: Log analytics workspace to associate with the OMS agent.

ClusterPoolResourcePropertiesResponseNetworkProfile

SubnetId string: Cluster pool subnet resource id.

SubnetId string: Cluster pool subnet resource id.

subnetId String: Cluster pool subnet resource id.

subnetId string: Cluster pool subnet resource id.

subnet_id str: Cluster pool subnet resource id.

subnetId String: Cluster pool subnet resource id.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.hdinsight.getClusterPool

On this page

On this page

Using getClusterPool

getClusterPool Result

Supporting Types

AksClusterProfileResponseAksClusterAgentPoolIdentityProfile

ClusterPoolResourcePropertiesResponseAksClusterProfile

ClusterPoolResourcePropertiesResponseClusterPoolProfile

ClusterPoolResourcePropertiesResponseComputeProfile

ClusterPoolResourcePropertiesResponseLogAnalyticsProfile

ClusterPoolResourcePropertiesResponseNetworkProfile

SystemDataResponse

Package Details

On this page

On this page