IHcpOpenShiftCluster Interface
Definition
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.HcpOpenShiftClusterTypeConverter))]
public interface IHcpOpenShiftCluster : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.ITrackedResource[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.HcpOpenShiftClusterTypeConverter))>]
type IHcpOpenShiftCluster = interface
interface IJsonSerializable
interface ITrackedResource
interface IResourcePublic Interface IHcpOpenShiftCluster
Implements ITrackedResource- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| ActiveKeyName |
name is the name of the keyvault key used for encryption/decryption. |
| 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. |
| ApiUrl |
URL endpoint for the API server |
| ApiVisibility |
The internet visibility of the OpenShift API server |
| 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 |
| ClusterImageRegistryState |
state indicates the desired ImageStream-backed cluster image registry installation mode. This can only be set during cluster creation and cannot be changed after cluster creation. Enabled means the ImageStream-backed image registry will be run as pods on worker nodes in the cluster. Disabled means the ImageStream-backed image registry will not be present in the cluster. The default is Enabled. |
| ConsoleUrl |
The cluster web console URL endpoint |
| ContainerRegistryManagedIdentity |
The user-assigned managed identity used for container registry image pulls. |
| CryptoRestriction |
Cryptographic restrictions for kernel and userspace libraries |
| CustomerManagedEncryptionType |
The encryption type used. By default, "KMS" is used. |
| DataEncryptionKeyManagementMode |
Specify the key management strategy used for the encryption key that encrypts the ETCD data. |
| DnsBaseDomain |
BaseDomain is the base DNS domain of the cluster. |
| DnsBaseDomainPrefix |
BaseDomainPrefix is the base domain prefix for the cluster ingress. It will be used to configure ingress in the cluster through the subdomain "BaseDomainPrefix.BaseDomain". |
| 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. |
| 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. |
| IngressType |
The type of the default cluster ingress. |
| KmKeyVaultType |
The type of keyvault used for KMS encryption. Defaults to KeyVault when absent. |
| KmVaultName |
vaultName is the name of the keyvault that contains the secret. |
| KmVisibility |
visibility of the keyvault that contains the secret. |
| Location |
The geo-location where the resource lives (Inherited from ITrackedResource) |
| Name |
The name of the resource (Inherited from IResource) |
| NetworkHostPrefix |
Network host prefix |
| NetworkMachineCidr |
The CIDR block from which to assign machine IP addresses |
| NetworkPodCidr |
The CIDR of the pod IP addresses |
| NetworkServiceCidr |
The CIDR block for assigned service IPs |
| NetworkType |
The main controller responsible for rendering the core networking components |
| 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 |
| PlatformIssuerUrl |
URL for the OIDC provider to be used for authentication to authenticate against user Azure cloud account |
| PlatformManagedResourceGroup |
The name of the resource group to put cluster resources in. If not specified then a unique name is generated from the following pattern "aro-hcp-" + clusterName + "-" + UUID where clusterName means the hcpOpenShiftClusters resource name (up to 45 characters) followed by a 16-byte universally unique identifier per RFC 4122. |
| PlatformNetworkSecurityGroupId |
ResourceId for the NSG (network security group) attached to the cluster subnet Note that NSGs cannot be reused for other ARO-HCP clusters. |
| PlatformOutboundType |
The core outgoing configuration |
| PlatformSubnetId |
The Azure resource ID of the worker subnet. Note that a subnet cannot be reused between ARO-HCP Clusters. |
| PlatformVnetIntegrationSubnetId |
The Azure resource ID of a subnet that enables direct, private network connectivity between the hosted control plane and your cluster's nodes. This subnet must be dedicated to ARO HCP and cannot be shared with the cluster subnet or any node pool subnets. |
| ProvisioningState |
The status of the last operation. |
| StatusActiveVersion |
The observed active versions of the cluster. During upgrades, both the previous and target versions may be active simultaneously until the rollout completes, so this array can contain more than one entry. 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) |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
| 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 |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |