@azure/arm-redhatopenshift package

Classes

AzureRedHatOpenShiftClient

Interfaces

APIServerProfile	APIServerProfile represents an API server profile.
AzureRedHatOpenShiftClientOptionalParams	Optional parameters for the client.
CloudError	CloudError represents a cloud error.
CloudErrorBody	CloudErrorBody represents the body of a cloud error.
ClusterProfile	ClusterProfile represents a cluster profile.
ConsoleProfile	ConsoleProfile represents a console profile.
Display	Display represents the display details of an operation.
EffectiveOutboundIP	EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.
IngressProfile	IngressProfile represents an ingress profile.
LoadBalancerProfile	LoadBalancerProfile represents the profile of the cluster public load balancer.
ManagedOutboundIPs	ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MasterProfile	MasterProfile represents a master profile.
NetworkProfile	NetworkProfile represents a network profile.
OpenShiftCluster	OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
OpenShiftClusterAdminKubeconfig	OpenShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.
OpenShiftClusterCredentials	OpenShiftClusterCredentials represents an OpenShift cluster's credentials.
OpenShiftClusterProperties	OpenShiftClusterProperties represents an OpenShift cluster's properties.
OpenShiftClusterUpdate	OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
OpenShiftClustersCreateOrUpdateOptionalParams	Optional parameters.
OpenShiftClustersDeleteOptionalParams	Optional parameters.
OpenShiftClustersGetOptionalParams	Optional parameters.
OpenShiftClustersListAdminCredentialsOptionalParams	Optional parameters.
OpenShiftClustersListByResourceGroupOptionalParams	Optional parameters.
OpenShiftClustersListCredentialsOptionalParams	Optional parameters.
OpenShiftClustersListOptionalParams	Optional parameters.
OpenShiftClustersOperations	Interface representing a OpenShiftClusters operations.
OpenShiftClustersUpdateOptionalParams	Optional parameters.
OpenShiftVersion	OpenShiftVersion represents an OpenShift version that can be installed.
OpenShiftVersionProperties	OpenShiftVersionProperties represents the properties of an OpenShiftVersion.
OpenShiftVersionsGetOptionalParams	Optional parameters.
OpenShiftVersionsListOptionalParams	Optional parameters.
OpenShiftVersionsOperations	Interface representing a OpenShiftVersions operations.
Operation	Operation represents an RP operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlatformWorkloadIdentity	PlatformWorkloadIdentity stores information representing a single workload identity.
PlatformWorkloadIdentityProfile	PlatformWorkloadIdentityProfile encapsulates all information that is specific to workload identity clusters.
PlatformWorkloadIdentityRole	PlatformWorkloadIdentityRole represents a mapping from a particular OCP operator to the built-in role that should be assigned to that operator's corresponding managed identity.
PlatformWorkloadIdentityRoleSet	PlatformWorkloadIdentityRoleSet represents a mapping from the names of OCP operators to the built-in roles that should be assigned to those operator's corresponding managed identities for a particular OCP version.
PlatformWorkloadIdentityRoleSetGetOptionalParams	Optional parameters.
PlatformWorkloadIdentityRoleSetOperations	Interface representing a PlatformWorkloadIdentityRoleSet operations.
PlatformWorkloadIdentityRoleSetProperties	PlatformWorkloadIdentityRoleSetProperties represents the properties of a PlatformWorkloadIdentityRoleSet resource.
PlatformWorkloadIdentityRoleSetsListOptionalParams	Optional parameters.
PlatformWorkloadIdentityRoleSetsOperations	Interface representing a PlatformWorkloadIdentityRoleSets operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ServicePrincipalProfile	ServicePrincipalProfile represents a service principal profile.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
WorkerProfile	WorkerProfile represents a worker profile.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
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.
EncryptionAtHost	EncryptionAtHost represents encryption at host state KnownEncryptionAtHost can be used interchangeably with EncryptionAtHost, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
FipsValidatedModules	FipsValidatedModules determines if FIPS is used. KnownFipsValidatedModules can be used interchangeably with FipsValidatedModules, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
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.
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: Loadbalancer UserDefinedRouting: UserDefinedRouting
PreconfiguredNSG	PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets KnownPreconfiguredNSG can be used interchangeably with PreconfiguredNSG, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
ProvisioningState	ProvisioningState represents a 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 AdminUpdating: AdminUpdating Canceled: Canceled Creating: Creating Deleting: Deleting Failed: Failed Succeeded: Succeeded Updating: Updating
Visibility	Visibility represents visibility. KnownVisibility can be used interchangeably with Visibility, this enum contains the known values that the service supports. Known values supported by the service Private: Private Public: Public

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownEncryptionAtHost	EncryptionAtHost represents encryption at host state
KnownFipsValidatedModules	FipsValidatedModules determines if FIPS is used.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOutboundType	The outbound routing strategy used to provide your cluster egress to the internet.
KnownPreconfiguredNSG	PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
KnownProvisioningState	ProvisioningState represents a provisioning state.
KnownVersions	The available API versions.
KnownVisibility	Visibility represents visibility.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AzureRedHatOpenShiftClient, 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>(AzureRedHatOpenShiftClient, 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: AzureRedHatOpenShiftClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AzureRedHatOpenShiftClient

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