Share via

@azure/arm-redhatopenshift package

  • Reference

Classes

AzureRedHatOpenShiftClient

Interfaces

APIServerProfile

APIServerProfile represents an API server profile.
AzureRedHatOpenShiftClientOptionalParams

Optional parameters.
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.
MachinePool

MachinePool represents a MachinePool
MachinePoolList

MachinePoolList represents a list of MachinePools
MachinePoolUpdate

MachinePool represents a MachinePool
MachinePools

Interface representing a MachinePools.
MachinePoolsCreateOrUpdateOptionalParams

Optional parameters.
MachinePoolsDeleteOptionalParams

Optional parameters.
MachinePoolsGetOptionalParams

Optional parameters.
MachinePoolsListNextOptionalParams

Optional parameters.
MachinePoolsListOptionalParams

Optional parameters.
MachinePoolsUpdateOptionalParams

Optional parameters.
ManagedOutboundIPs

ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
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.
OpenShiftClusterList

OpenShiftClusterList represents a list of OpenShift clusters.
OpenShiftClusterUpdate

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
OpenShiftClusters

Interface representing a OpenShiftClusters.
OpenShiftClustersCreateOrUpdateOptionalParams

Optional parameters.
OpenShiftClustersDeleteOptionalParams

Optional parameters.
OpenShiftClustersGetOptionalParams

Optional parameters.
OpenShiftClustersListAdminCredentialsOptionalParams

Optional parameters.
OpenShiftClustersListByResourceGroupNextOptionalParams

Optional parameters.
OpenShiftClustersListByResourceGroupOptionalParams

Optional parameters.
OpenShiftClustersListCredentialsOptionalParams

Optional parameters.
OpenShiftClustersListNextOptionalParams

Optional parameters.
OpenShiftClustersListOptionalParams

Optional parameters.
OpenShiftClustersUpdateOptionalParams

Optional parameters.
OpenShiftVersion

OpenShiftVersion represents an OpenShift version that can be installed.
OpenShiftVersionList

OpenShiftVersionList represents a List of available versions.
OpenShiftVersions

Interface representing a OpenShiftVersions.
OpenShiftVersionsListNextOptionalParams

Optional parameters.
OpenShiftVersionsListOptionalParams

Optional parameters.
Operation

Operation represents an RP operation.
OperationList

OperationList represents an RP operation list.
Operations

Interface representing a Operations.
OperationsListNextOptionalParams

Optional parameters.
OperationsListOptionalParams

Optional parameters.
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
Secret

Secret represents a secret.
SecretList

SecretList represents a list of Secrets
SecretUpdate

Secret represents a secret.
Secrets

Interface representing a Secrets.
SecretsCreateOrUpdateOptionalParams

Optional parameters.
SecretsDeleteOptionalParams

Optional parameters.
SecretsGetOptionalParams

Optional parameters.
SecretsListNextOptionalParams

Optional parameters.
SecretsListOptionalParams

Optional parameters.
SecretsUpdateOptionalParams

Optional parameters.
ServicePrincipalProfile

ServicePrincipalProfile represents a service principal profile.
SyncIdentityProvider

SyncIdentityProvider represents a SyncIdentityProvider
SyncIdentityProviderList

SyncSetList represents a list of SyncSets
SyncIdentityProviderUpdate

SyncIdentityProvider represents a SyncIdentityProvider
SyncIdentityProviders

Interface representing a SyncIdentityProviders.
SyncIdentityProvidersCreateOrUpdateOptionalParams

Optional parameters.
SyncIdentityProvidersDeleteOptionalParams

Optional parameters.
SyncIdentityProvidersGetOptionalParams

Optional parameters.
SyncIdentityProvidersListNextOptionalParams

Optional parameters.
SyncIdentityProvidersListOptionalParams

Optional parameters.
SyncIdentityProvidersUpdateOptionalParams

Optional parameters.
SyncSet

SyncSet represents a SyncSet for an Azure Red Hat OpenShift Cluster.
SyncSetList

SyncSetList represents a list of SyncSets
SyncSetUpdate

SyncSet represents a SyncSet for an Azure Red Hat OpenShift Cluster.
SyncSets

Interface representing a SyncSets.
SyncSetsCreateOrUpdateOptionalParams

Optional parameters.
SyncSetsDeleteOptionalParams

Optional parameters.
SyncSetsGetOptionalParams

Optional parameters.
SyncSetsListNextOptionalParams

Optional parameters.
SyncSetsListOptionalParams

Optional parameters.
SyncSetsUpdateOptionalParams

Optional parameters.
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'
WorkerProfile

WorkerProfile represents a worker profile.

Type Aliases

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key
EncryptionAtHost

Defines values for EncryptionAtHost.
KnownEncryptionAtHost can be used interchangeably with EncryptionAtHost, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled
FipsValidatedModules

Defines values for FipsValidatedModules.
KnownFipsValidatedModules can be used interchangeably with FipsValidatedModules, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled
MachinePoolsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
MachinePoolsGetResponse

Contains response data for the get operation.
MachinePoolsListNextResponse

Contains response data for the listNext operation.
MachinePoolsListResponse

Contains response data for the list operation.
MachinePoolsUpdateResponse

Contains response data for the update operation.
OpenShiftClustersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
OpenShiftClustersGetResponse

Contains response data for the get operation.
OpenShiftClustersListAdminCredentialsResponse

Contains response data for the listAdminCredentials operation.
OpenShiftClustersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.
OpenShiftClustersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.
OpenShiftClustersListCredentialsResponse

Contains response data for the listCredentials operation.
OpenShiftClustersListNextResponse

Contains response data for the listNext operation.
OpenShiftClustersListResponse

Contains response data for the list operation.
OpenShiftClustersUpdateResponse

Contains response data for the update operation.
OpenShiftVersionsListNextResponse

Contains response data for the listNext operation.
OpenShiftVersionsListResponse

Contains response data for the list operation.
OperationsListNextResponse

Contains response data for the listNext operation.
OperationsListResponse

Contains response data for the list operation.
OutboundType

Defines values for OutboundType.
KnownOutboundType can be used interchangeably with OutboundType, this enum contains the known values that the service supports.

Known values supported by the service

Loadbalancer
UserDefinedRouting
PreconfiguredNSG

Defines values for PreconfiguredNSG.
KnownPreconfiguredNSG can be used interchangeably with PreconfiguredNSG, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled
ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

AdminUpdating
Canceled
Creating
Deleting
Failed
Succeeded
Updating
SecretsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
SecretsGetResponse

Contains response data for the get operation.
SecretsListNextResponse

Contains response data for the listNext operation.
SecretsListResponse

Contains response data for the list operation.
SecretsUpdateResponse

Contains response data for the update operation.
SyncIdentityProvidersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
SyncIdentityProvidersGetResponse

Contains response data for the get operation.
SyncIdentityProvidersListNextResponse

Contains response data for the listNext operation.
SyncIdentityProvidersListResponse

Contains response data for the list operation.
SyncIdentityProvidersUpdateResponse

Contains response data for the update operation.
SyncSetsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
SyncSetsGetResponse

Contains response data for the get operation.
SyncSetsListNextResponse

Contains response data for the listNext operation.
SyncSetsListResponse

Contains response data for the list operation.
SyncSetsUpdateResponse

Contains response data for the update operation.
Visibility

Defines values for 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
Public

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownEncryptionAtHost

Known values of EncryptionAtHost that the service accepts.
KnownFipsValidatedModules

Known values of FipsValidatedModules that the service accepts.
KnownOutboundType

Known values of OutboundType that the service accepts.
KnownPreconfiguredNSG

Known values of PreconfiguredNSG that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownVisibility

Known values of Visibility that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.