@azure/arm-redhatopenshifthcp package

Classes

RedHatOpenShiftClient

Interfaces

ApiProfile	Information about the API of a cluster.
ApiProfileCreate	API profile for create/update operations, omitting server-side read-only field url.
ClusterAutoscalingProfile	ClusterAutoscaling specifies auto-scaling behavior that applies to all NodePools associated with a control plane.
ClusterImageRegistryProfile	OpenShift cluster image registry
Condition	Condition represents an observation of a resource's state.
ConsoleProfile	Configuration of the cluster web console
CustomerManagedEncryptionProfile	Customer managed encryption key profile.
DnsProfile	DNS contains the DNS settings of the cluster
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EtcdDataEncryptionProfile	The ETCD data encryption settings.
EtcdProfile	The ETCD settings and configuration options.
ExternalAuth	ExternalAuth resource
ExternalAuthClaimProfile	External Auth claim profile
ExternalAuthClientComponentProfile	External Auth component profile Must have unique namespace/name pairs.
ExternalAuthClientProfile	External Auth client profile This configures how on-cluster, platform clients should request tokens from the identity provider.
ExternalAuthProperties	External Auth profile
ExternalAuthsCreateOrUpdateOptionalParams	Optional parameters.
ExternalAuthsDeleteOptionalParams	Optional parameters.
ExternalAuthsGetOptionalParams	Optional parameters.
ExternalAuthsListByParentOptionalParams	Optional parameters.
ExternalAuthsOperations	Interface representing a ExternalAuths operations.
ExternalAuthsUpdateOptionalParams	Optional parameters.
GroupClaimProfile	External Auth claim profile This configures how the groups of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. When referencing a claim, if the claim is present in the JWT token, its value must be a list of groups separated by a comma (','). For example - '"example"' and '"exampleOne", "exampleTwo", "exampleThree"' are valid claim values.
HcpOpenShiftCluster	HCP cluster resource
HcpOpenShiftClusterAdminCredential	HCP cluster admin credential
HcpOpenShiftClusterAdminCredentialRequest	HCP cluster admin credential request body
HcpOpenShiftClusterProperties	HCP cluster properties
HcpOpenShiftClusterPropertiesCreate	HCP cluster properties for create/update operations, omitting server-side read-only fields (console and status on the root model; api.url and platform.issuerUrl in nested models).
HcpOpenShiftClusterResourceCreate	HCP cluster resource for create/update operations.
HcpOpenShiftClusterUpdate	The template for adding updateable properties.
HcpOpenShiftClustersCreateOrUpdateOptionalParams	Optional parameters.
HcpOpenShiftClustersDeleteOptionalParams	Optional parameters.
HcpOpenShiftClustersGetOptionalParams	Optional parameters.
HcpOpenShiftClustersListByResourceGroupOptionalParams	Optional parameters.
HcpOpenShiftClustersListBySubscriptionOptionalParams	Optional parameters.
HcpOpenShiftClustersOperations	Interface representing a HcpOpenShiftClusters operations.
HcpOpenShiftClustersRequestAdminCredentialOptionalParams	Optional parameters.
HcpOpenShiftClustersRevokeCredentialsOptionalParams	Optional parameters.
HcpOpenShiftClustersUpdateOptionalParams	Optional parameters.
HcpOpenShiftVersion	HcpOpenShiftVersion represents a location based available HCP OpenShift version
HcpOpenShiftVersionProperties	HcpOpenShiftVersionProperties contains details of an available HCP Openshift version
HcpOpenShiftVersionsGetOptionalParams	Optional parameters.
HcpOpenShiftVersionsListOptionalParams	Optional parameters.
HcpOpenShiftVersionsOperations	Interface representing a HcpOpenShiftVersions operations.
HcpOperatorIdentityRoleSet	HcpOperatorIdentityRoles represents a location based representation of the required platform workload identities and their required roles for a given OpenShift version
HcpOperatorIdentityRoleSetProperties	HCP Operator Identity Roles properties
HcpOperatorIdentityRoleSetsGetOptionalParams	Optional parameters.
HcpOperatorIdentityRoleSetsListOptionalParams	Optional parameters.
HcpOperatorIdentityRoleSetsOperations	Interface representing a HcpOperatorIdentityRoleSets operations.
ImageDigestMirror	ImageDigestMirror specifies a set of mirror registries to redirect image pulls targeting the specified source registries.
IngressProfile	Information about the Ingress of a cluster.
KmsEncryptionProfile	Configure etcd encryption Key Management Service (KMS) key. Your Microsoft Entra application used to create the cluster must be authorized to access this keyvault, e.g using the AzureCLI: az keyvault set-policy -n $KEYVAULT_NAME --key-permissions decrypt encrypt --spn (YOUR APPLICATION CLIENT ID)
KmsKey	A representation of a KeyVault Secret.
Label	Label represents the Kubernetes label
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NetworkProfile	OpenShift networking configuration
NodePool	Concrete tracked resource types can be created by aliasing this type using a specific property type.
NodePoolAutoScaling	Node pool autoscaling
NodePoolPlatformProfile	Azure node pool platform configuration
NodePoolProperties	Represents the node pool properties
NodePoolVersionProfile	Versions represents an OpenShift version.
NodePoolsCreateOrUpdateOptionalParams	Optional parameters.
NodePoolsDeleteOptionalParams	Optional parameters.
NodePoolsGetOptionalParams	Optional parameters.
NodePoolsListByParentOptionalParams	Optional parameters.
NodePoolsOperations	Interface representing a NodePools operations.
NodePoolsUpdateOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OperatorIdentityRoles	Role definitions for a specific operator
OperatorsAuthenticationProfile	The configuration that the operators of the cluster have to authenticate to Azure.
OsDiskProfile	The settings and configuration options for OSDisk
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlatformProfile	Azure specific configuration
PlatformProfileCreate	Azure platform configuration for create/update operations, omitting server-side read-only field issuerUrl.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RedHatOpenShiftClientOptionalParams	Optional parameters for the client.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceStatus	ResourceStatus represents the observed status of the resource.
RestorePollerOptions
RoleDefinition	A single role definition required by a given operator
SystemData	Metadata pertaining to creation and last modification of the resource.
Taint	Taint is controlling the node taint and its effects
TokenClaimMappingsProfile	External Auth claim mappings profile. At a minimum username or groups must be defined.
TokenClaimValidationRule	External Auth claim validation rule
TokenIssuerProfile	Token issuer profile This configures how the platform interacts with the identity provider and how tokens issued from the identity provider are evaluated by the Kubernetes API server.
TokenRequiredClaim	Token required claim validation rule.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UpdateablePropertiesNodePoolProperties	The template for adding updateable properties.
UserAssignedIdentitiesProfile	Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities
UserAssignedIdentity	User assigned identity properties
UsernameClaimProfile	External Auth claim profile This configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider.
VersionProfile	Versions represents an OpenShift version.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ClusterImageRegistryState	The desired state of the ImageStream-backed cluster image registry KnownClusterImageRegistryState can be used interchangeably with ClusterImageRegistryState, this enum contains the known values that the service supports. Known values supported by the service Enabled: The ImageStream-backed image registry will be run as pods on worker nodes Disabled: The ImageStream-backed image registry will not be present in the cluster
ConditionType	Representation of the possible condition types. KnownConditionType can be used interchangeably with ConditionType, this enum contains the known values that the service supports. Known values supported by the service Available: Indicates that the resource is available. Degraded: Indicates that the resource is in a degraded state. Progressing: Indicates that the resource is in a progressing state.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
CryptoRestrictions	Cryptographic restrictions for kernel and userspace libraries KnownCryptoRestrictions can be used interchangeably with CryptoRestrictions, this enum contains the known values that the service supports. Known values supported by the service None: No restrictions FIPS: Use only FIPS-validated algorithms and implementations
CustomerManagedEncryptionType	The encryption types supported for a customer managed key. KnownCustomerManagedEncryptionType can be used interchangeably with CustomerManagedEncryptionType, this enum contains the known values that the service supports. Known values supported by the service KMS: KMS encryption type.
DiskStorageAccountType	Supported Azure storage account types https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types KnownDiskStorageAccountType can be used interchangeably with DiskStorageAccountType, this enum contains the known values that the service supports. Known values supported by the service Premium_LRS: Premium SSD with Locally Redundant Storage (LRS) StandardSSD_LRS: Standard SSD with Locally Redundant Storage (LRS) Standard_LRS: Standard HDD with Locally Redundant Storage (LRS)
Effect	The taint effect the same as in Kubernetes KnownEffect can be used interchangeably with Effect, this enum contains the known values that the service supports. Known values supported by the service NoSchedule: NoSchedule taint effect PreferNoSchedule: PreferNoSchedule taint effect NoExecute: NoExecute taint effect
EtcdDataEncryptionKeyManagementModeType	The encryption key management mode types supported for ETCD data encryption. KnownEtcdDataEncryptionKeyManagementModeType can be used interchangeably with EtcdDataEncryptionKeyManagementModeType, this enum contains the known values that the service supports. Known values supported by the service CustomerManaged: Customer managed encryption key management mode type.
ExternalAuthClientType	Representation of the possible values of an external authentication client's type KnownExternalAuthClientType can be used interchangeably with ExternalAuthClientType, this enum contains the known values that the service supports. Known values supported by the service Confidential: Indicates that the client is confidential. Confidential clients must provide a client secret. The secret should be provided within the cluster itself. Public: Indicates that the client is public. Public clients must not provide a client secret.
ExternalAuthProvisioningState	The resource provisioning state. KnownExternalAuthProvisioningState can be used interchangeably with ExternalAuthProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Accepted: Non-terminal state indicating the resource has been accepted Deleting: Non-terminal state indicating the resource is deleting Provisioning: Non-terminal state indicating the resource is provisioning Updating: Non-terminal state indicating the resource is updating AwaitingSecret: Non-terminal state indicating the resource is awaiting secret
IngressType	The type of the default cluster ingress. KnownIngressType can be used interchangeably with IngressType, this enum contains the known values that the service supports. Known values supported by the service Public: The default ingress is visible from the internet. Private: The default ingress is not visible from the internet. Disabled: The default ingress is disabled.
KeyVaultVisibility	The internet visibility of a keyvault resource KnownKeyVaultVisibility can be used interchangeably with KeyVaultVisibility, this enum contains the known values that the service supports. Known values supported by the service Public: The keyvault is visible from the internet. Private: The keyvault is not visible from the internet.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
NetworkType	The cluster network type KnownNetworkType can be used interchangeably with NetworkType, this enum contains the known values that the service supports. Known values supported by the service OVNKubernetes: The OVN network plugin for the OpenShift cluster Other: Other network plugins
OperatorIdentityRequired	Indicates if the identity is required KnownOperatorIdentityRequired can be used interchangeably with OperatorIdentityRequired, this enum contains the known values that the service supports. Known values supported by the service Always: Indicates the identity is always required. OnEnablement: Indicates the identity is only required when a functionality that leverages the operator is enabled.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
OsDiskType	The type of the OS disk https://learn.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks KnownOsDiskType can be used interchangeably with OsDiskType, this enum contains the known values that the service supports. Known values supported by the service Managed: Managed OS disk - stored as an Azure managed disk (network-attached). Default behavior for VMs without sufficient cache. Ephemeral: Ephemeral OS disk - stored on local VM cache/temporary storage. Provides lower latency and faster node operations. Requires VM with sufficient cache size.
OutboundType	The outbound routing strategy used to provide your cluster egress to the internet. KnownOutboundType can be used interchangeably with OutboundType, this enum contains the known values that the service supports. Known values supported by the service LoadBalancer: The load balancer configuration
ProvisioningState	The resource provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Accepted: Non-terminal state indicating the resource has been accepted Deleting: Non-terminal state indicating the resource is deleting Provisioning: Non-terminal state indicating the resource is provisioning Updating: Non-terminal state indicating the resource is updating
StatusType	Representation of the possible values of a condition status. KnownStatusType can be used interchangeably with StatusType, this enum contains the known values that the service supports. Known values supported by the service True: Indicates that the condition status is True. False: Indicates that the condition status is False. Unknown: Indicates that the condition status is unknown.
TokenValidationRuleType	Representation of the different claim validation rule types that can be configured. KnownTokenValidationRuleType can be used interchangeably with TokenValidationRuleType, this enum contains the known values that the service supports. Known values supported by the service RequiredClaim: Indicates that a Required Claim validation rule. When set to 'RequiredClaim', the Kubernetes API server will be configured to validate that the incoming JWT contains the required claim and that its value matches the required value.
UsernameClaimPrefixPolicy	UsernameClaimPrefixPolicy configures whether to add a prefix to a JWT claim. KnownUsernameClaimPrefixPolicy can be used interchangeably with UsernameClaimPrefixPolicy, this enum contains the known values that the service supports. Known values supported by the service None: No opinion; the platform is left to choose a prefix for the JWT claim Prefix: Add a user-provided prefix to the JWT claim NoPrefix: Do not add a prefix to the JWT claim
Visibility	The internet visibility of the OpenShift API server KnownVisibility can be used interchangeably with Visibility, this enum contains the known values that the service supports. Known values supported by the service Public: The API server is visible from the internet. Private: The API server is not visible from the internet.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownClusterImageRegistryState	The desired state of the ImageStream-backed cluster image registry
KnownConditionType	Representation of the possible condition types.
KnownCreatedByType	The kind of entity that created the resource.
KnownCryptoRestrictions	Cryptographic restrictions for kernel and userspace libraries
KnownCustomerManagedEncryptionType	The encryption types supported for a customer managed key.
KnownDiskStorageAccountType	Supported Azure storage account types https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types
KnownEffect	The taint effect the same as in Kubernetes
KnownEtcdDataEncryptionKeyManagementModeType	The encryption key management mode types supported for ETCD data encryption.
KnownExternalAuthClientType	Representation of the possible values of an external authentication client's type
KnownExternalAuthProvisioningState	The resource provisioning state.
KnownIngressType	The type of the default cluster ingress.
KnownKeyVaultVisibility	The internet visibility of a keyvault resource
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownNetworkType	The cluster network type
KnownOperatorIdentityRequired	Indicates if the identity is required
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOsDiskType	The type of the OS disk https://learn.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks
KnownOutboundType	The outbound routing strategy used to provide your cluster egress to the internet.
KnownProvisioningState	The resource provisioning state.
KnownStatusType	Representation of the possible values of a condition status.
KnownTokenValidationRuleType	Representation of the different claim validation rule types that can be configured.
KnownUsernameClaimPrefixPolicy	UsernameClaimPrefixPolicy configures whether to add a prefix to a JWT claim.
KnownVersions	The available API versions.
KnownVisibility	The internet visibility of the OpenShift API server

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(RedHatOpenShiftClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(RedHatOpenShiftClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: RedHatOpenShiftClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

RedHatOpenShiftClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor