Share via

OpenShiftCluster interface

Package:
@azure/arm-redhatopenshift

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

Extends
TrackedResource

Properties

apiserverProfile

The cluster API server profile.
clusterProfile

The cluster profile.
consoleProfile

The console profile.
ingressProfiles

The cluster ingress profiles.
masterProfile

The cluster master profile.
networkProfile

The cluster network profile.
provisioningState

The cluster provisioning state.
servicePrincipalProfile

The cluster service principal profile.
workerProfiles

The cluster worker profiles.
workerProfilesStatus

The cluster worker profiles status. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiserverProfile

The cluster API server profile.

apiserverProfile?: APIServerProfile

Property Value

APIServerProfile

clusterProfile

The cluster profile.

clusterProfile?: ClusterProfile

Property Value

ClusterProfile

consoleProfile

The console profile.

consoleProfile?: ConsoleProfile

Property Value

ConsoleProfile

ingressProfiles

The cluster ingress profiles.

ingressProfiles?: IngressProfile[]

Property Value

IngressProfile[]

masterProfile

The cluster master profile.

masterProfile?: MasterProfile

Property Value

MasterProfile

networkProfile

The cluster network profile.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

provisioningState

The cluster provisioning state.

provisioningState?: string

Property Value

string

servicePrincipalProfile

The cluster service principal profile.

servicePrincipalProfile?: ServicePrincipalProfile

Property Value

ServicePrincipalProfile

workerProfiles

The cluster worker profiles.

workerProfiles?: WorkerProfile[]

Property Value

WorkerProfile[]

workerProfilesStatus

The cluster worker profiles status. NOTE: This property will not be serialized. It can only be populated by the server.

workerProfilesStatus?: WorkerProfile[]

Property Value

WorkerProfile[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type