Share via


ProvisionedCluster Class

Definition

The provisioned cluster resource definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.ProvisionedClusterTypeConverter))]
public class ProvisionedCluster : Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IProvisionedCluster, Microsoft.Azure.PowerShell.Cmdlets.AksArc.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.ProvisionedClusterTypeConverter))>]
type ProvisionedCluster = class
    interface IProvisionedCluster
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates
Public Class ProvisionedCluster
Implements IProvisionedCluster, IValidates
Inheritance
ProvisionedCluster
Attributes
Implements

Constructors

ProvisionedCluster()

Creates an new ProvisionedCluster instance.

Properties

AgentPoolProfile

The agent pool properties for the provisioned cluster.

AutoScalerProfileBalanceSimilarNodeGroup

Valid values are 'true' and 'false'

AutoScalerProfileExpander

If not specified, the default is 'random'. See expanders for more information.

AutoScalerProfileMaxEmptyBulkDelete

The default is 10.

AutoScalerProfileMaxGracefulTerminationSec

The default is 600.

AutoScalerProfileMaxNodeProvisionTime

The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileMaxTotalUnreadyPercentage

The default is 45. The maximum is 100 and the minimum is 0.

AutoScalerProfileNewPodScaleUpDelay

For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc).

AutoScalerProfileOkTotalUnreadyCount

This must be an integer. The default is 3.

AutoScalerProfileScaleDownDelayAfterAdd

The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileScaleDownDelayAfterDelete

The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileScaleDownDelayAfterFailure

The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileScaleDownUnneededTime

The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileScaleDownUnreadyTime

The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

AutoScalerProfileScaleDownUtilizationThreshold

The default is '0.5'.

AutoScalerProfileScanInterval

The default is '10'. Values must be an integer number of seconds.

AutoScalerProfileSkipNodesWithLocalStorage

The default is true.

AutoScalerProfileSkipNodesWithSystemPod

The default is true.

ClusterVMAccessProfileAuthorizedIprange

IP Address or CIDR for SSH access to VMs in the provisioned cluster

ControlPlaneCount

Number of control plane nodes. The default value is 1, and the count should be an odd number

ControlPlaneEndpointHostIP

IP address of the Kubernetes API server

ControlPlaneVMSize

VM sku size of the control plane nodes

ExtendedLocationName

ARM Id of the extended location.

ExtendedLocationType

The extended location type. Allowed value: 'CustomLocation'

Id

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

InfraNetworkProfileVnetSubnetId

List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}

KubernetesVersion

The version of Kubernetes in use by the provisioned cluster.

LicenseProfileAzureHybridBenefit

Indicates whether Azure Hybrid Benefit is opted in. Default value is false

LoadBalancerProfileCount

Number of HA Proxy load balancer VMs. The default value is 0.

Name

The name of the resource

NetworkProfileNetworkPolicy

Network policy used for building Kubernetes network. Possible values include: 'calico'.

NetworkProfilePodCidr

A CIDR notation IP Address range from which to assign pod IPs.

NfCsiDriverEnabled

Indicates whether to enable NFS CSI Driver. The default value is true.

ProvisioningState

The status of the latest long running operation for the provisioned cluster.

ResourceGroupName

Gets the resource group name

SmbCsiDriverEnabled

Indicates whether to enable SMB CSI Driver. The default value is true.

SshPublicKey

The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified.

StatusControlPlaneStatus

The detailed status of the provisioned cluster components including addons.

StatusCurrentState

The current state of the provisioned cluster.

StatusErrorMessage

Error messages during a provisioned cluster operation or steady state.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ProvisionedCluster.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ProvisionedCluster.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IProvisionedCluster.

FromJsonString(String)

Creates a new instance of ProvisionedCluster, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ProvisionedCluster into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to