INodePool Interface

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:: Az.RedHatOpenShiftHcp.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.NodePoolTypeConverter))]
public interface INodePool : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ITrackedResource

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.NodePoolTypeConverter))>]
type INodePool = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource

Public Interface INodePool
Implements ITrackedResource

Derived: Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.NodePool

Attributes: TypeConverterAttribute

Implements: IResource ITrackedResource IJsonSerializable

Properties

Name	Description
AutoRepair	autoRepair specifies whether health checks should be enabled for machines in the NodePool. Enabling this feature will cause the controller to automatically delete unhealthy machines. The unhealthy criteria are determined by checking the Node Ready condition and a timeout that might vary depending on the platform provider. autoRepair will not take action when more than 2 Nodes are unhealthy at the same time, giving time for the cluster to stabilize or for the user to manually intervene.
AutoScalingMax	The maximum number of nodes in the node pool. Validation: Minimum: 0 (must be >= min) Maximum: 200 (only when availabilityZone is not specified) No maximum when availabilityZone is specified
AutoScalingMin	The minimum number of nodes in the node pool. Validation: Minimum: 0 Maximum: 200 (only when availabilityZone is not specified) No maximum when availabilityZone is specified
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from IResource)
IdentityPrincipalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityTenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
Label	Kubernetes labels to propagate to the NodePool Nodes. Note that when the labels are updated this is only applied to newly created nodes in the NodePool, existing node labels remain unchanged.
Location	The geo-location where the resource lives (Inherited from ITrackedResource)
Name	The name of the resource (Inherited from IResource)
NodeDrainTimeoutMinute	nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default.
OSDiskEncryptionSetId	The ID of the DiskEncryptionSet resource to use to encrypt the OS disks for the VMs. This needs to exist in the same subscription id listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.SubscriptionID. DiskEncryptionSetID should also exist in a resource group under the same subscription id and the same location listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.Location. Details on how to create a Disk Encryption Set can be found here: https://learn.microsoft.com/en-us/azure/virtual-machines/disks-enable-customer-managed-keys-portal#set-up-your-disk-encryption-set
OSDiskSizeGiB	The OS disk size in GiB. Maximum is 4095 GiB for Managed disks. For Ephemeral disks, the maximum is 2040 GiB; Azure may enforce a lower effective limit based on the selected VM size's local cache, temp, or NVMe capacity.
OSDiskStorageAccountType	The type of the disk storage account https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types
OSDiskType	The type of the OS disk. https://learn.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks
PlatformAvailabilityZone	The availability zone for the node pool. Please read the documentation to see which regions support availability zones https://learn.microsoft.com/en-us/azure/availability-zones/az-overview
PlatformEnableEncryptionAtHost	Whether to enable host based OS and data drive encryption. https://learn.microsoft.com/en-us/azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data
PlatformSubnetId	The Azure resource ID of the worker subnet. Note that a subnet cannot be reused between ARO-HCP Clusters, however the same subnet can be used for NodePools of the same cluster.
PlatformVMSize	The VM size according to the documentation: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes
ProvisioningState	Provisioning state
Replica	The number of worker nodes, it cannot be used together with autoscaling. Validation: Minimum: 0 Maximum: 200 (only when availabilityZone is not specified) No maximum when availabilityZone is specified
StatusActiveVersion	The observed active versions of the node pool. During upgrades, it is common for multiple versions to be active at the same time while old nodes are drained and replaced. The ordering of entries has no meaning.
StatusCondition	The conditions on 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)
Taint	Taints for the nodes.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource)
VersionChannelGroup	ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'. This property is intended to be updateable, but that support is not yet complete. Until then, changing this value after node pool creation is rejected.
VersionId	ID is the unique identifier of the version.

Methods

Name	Description
ToJson(JsonObject, SerializationMode)	(Inherited from IJsonSerializable)

Applies to