IClusterPool Interface

Definition

C#
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.HdInsightOnAks.Models.ClusterPoolTypeConverter))]
public interface IClusterPool : Microsoft.Azure.PowerShell.Cmdlets.HdInsightOnAks.Models.ITrackedResource
Derived
Attributes
Implements

Properties

AkClusterProfileAkClusterAgentPoolIdentityProfileMsiClientId

ClientId of the MSI.

AkClusterProfileAkClusterAgentPoolIdentityProfileMsiObjectId

ObjectId of the MSI.

AkClusterProfileAkClusterAgentPoolIdentityProfileMsiResourceId

ResourceId of the MSI.

AkClusterProfileAksClusterResourceId

ARM Resource ID of the AKS cluster

AkClusterProfileAksVersion

AKS control plane and default node pool version of this ClusterPool

AksManagedResourceGroupName

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}

ComputeProfileAvailabilityZone

The list of Availability zones to use for AKS VMSS nodes.

ComputeProfileCount

The number of virtual machines.

ComputeProfileVMSize

The virtual machine SKU.

DeploymentId

A unique id generated by the RP to identify the resource.

Id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

(Inherited from IResource)
Location

The geo-location where the resource lives

(Inherited from ITrackedResource)
LogAnalyticProfileEnabled

True if log analytics is enabled for cluster pool, otherwise false.

LogAnalyticProfileWorkspaceId

Log analytics workspace to associate with the OMS agent.

ManagedResourceGroupName

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.

Name

The name of the resource

(Inherited from IResource)
NetworkProfileApiServerAuthorizedIPRange

IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don't use it.

NetworkProfileEnablePrivateApiServer

ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

NetworkProfileOutboundType

This can only be set at cluster pool creation time and cannot be changed later.

NetworkProfileSubnetId

Cluster pool subnet resource id.

ProfileClusterPoolVersion

Cluster pool version is a 2-part version.

ProvisioningState

Provisioning state of the resource.

Status

Business status of the resource.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

(Inherited from IResource)
SystemDataCreatedBy

The identity that created the resource.

(Inherited from IResource)
SystemDataCreatedByType

The type of identity that created the resource.

(Inherited from IResource)
SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

(Inherited from IResource)
SystemDataLastModifiedBy

The identity that last modified the resource.

(Inherited from IResource)
SystemDataLastModifiedByType

The type of identity that last modified the resource.

(Inherited from IResource)
Tag

Resource tags.

(Inherited from ITrackedResource)
Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

(Inherited from IResource)

Methods

Applies to

Product Versions
Azure - PowerShell Commands 12 (LTS), Latest