Language

HcpOpenShiftClusterUpdate Class

Definition

HCP cluster resource

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.HcpOpenShiftClusterUpdateTypeConverter))]
public class HcpOpenShiftClusterUpdate : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IHcpOpenShiftClusterUpdate, Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.HcpOpenShiftClusterUpdateTypeConverter))>]
type HcpOpenShiftClusterUpdate = class
    interface IHcpOpenShiftClusterUpdate
    interface IJsonSerializable
    interface IAzureResourceManagerCommonTypesTrackedResourceUpdate
    interface IResource
    interface IValidates
Public Class HcpOpenShiftClusterUpdate
Implements IHcpOpenShiftClusterUpdate, IValidates
Inheritance
HcpOpenShiftClusterUpdate
Attributes
Implements

Constructors

Name Description
HcpOpenShiftClusterUpdate()

Creates an new HcpOpenShiftClusterUpdate instance.

Properties

Name Description
ActiveKeyVersion

version contains the version of the key to use.

ApiAuthorizedCidR

The list of authorized IPv4 CIDR blocks allowed to access the API server. Maximum 500 entries.

AutoscalingMaxNodeProvisionTimeSecond

maxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes.

AutoscalingMaxNodesTotal

maxNodesTotal is the maximum allowable number of nodes. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit.

AutoscalingMaxPodGracePeriodSecond

maxPodGracePeriodSeconds is the maximum amount of time in seconds to wait for graceful pod termination before scaling down a NodePool. The default is 600 seconds.

AutoscalingPodPriorityThreshold

podPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption

ContainerRegistryManagedIdentity

The user-assigned managed identity used for container registry image pulls.

Id

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

IdentityType

The type of managed identity assigned to this resource.

IdentityUserAssignedIdentity

The identities assigned to this resource by the user.

ImageDigestMirror

imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster.

Name

The name of the resource

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 in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This value is used as a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool

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.

Tag

Resource tags.

Type

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

UserAssignedIdentityControlPlaneOperator

The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version.

UserAssignedIdentityDataPlaneOperator

The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version.

UserAssignedIdentityServiceManagedIdentity

Represents the information associated to an Azure User-Assigned Managed Identity whose purpose is to perform service level actions.

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 cluster creation is rejected.

VersionId

ID is the desired X.Y version of the cluster control plane.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of HcpOpenShiftClusterUpdate.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of HcpOpenShiftClusterUpdate.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IHcpOpenShiftClusterUpdate.

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of HcpOpenShiftClusterUpdate into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to