redhatopenshift.azure.com/v1api20231122
APIVersion
| Value | Description |
|---|---|
| “2023-11-22” |
OpenShiftCluster
Generator information: - Generated from: /redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/redhatopenshift.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
Used by: OpenShiftClusterList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | OpenShiftCluster_Spec Optional |
|
| status | OpenShiftCluster_STATUS Optional |
OpenShiftCluster_Spec
| Property | Description | Type |
|---|---|---|
| apiserverProfile | The cluster API server profile. | APIServerProfile Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clusterProfile | The cluster profile. | ClusterProfile Optional |
| ingressProfiles | The cluster ingress profiles. | IngressProfile[] Optional |
| location | The geo-location where the resource lives | string Required |
| masterProfile | The cluster master profile. | MasterProfile Optional |
| networkProfile | The cluster network profile. | NetworkProfile Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | OpenShiftClusterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| servicePrincipalProfile | The cluster service principal profile. | ServicePrincipalProfile Optional |
| tags | Resource tags. | map[string]string Optional |
| workerProfiles | The cluster worker profiles. | WorkerProfile[] Optional |
OpenShiftCluster_STATUS
| Property | Description | Type |
|---|---|---|
| apiserverProfile | The cluster API server profile. | APIServerProfile_STATUS Optional |
| clusterProfile | The cluster profile. | ClusterProfile_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| consoleProfile | The console profile. | ConsoleProfile_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| ingressProfiles | The cluster ingress profiles. | IngressProfile_STATUS[] Optional |
| location | The geo-location where the resource lives | string Optional |
| masterProfile | The cluster master profile. | MasterProfile_STATUS Optional |
| name | The name of the resource | string Optional |
| networkProfile | The cluster network profile. | NetworkProfile_STATUS Optional |
| provisioningState | The cluster provisioning state. | ProvisioningState_STATUS Optional |
| servicePrincipalProfile | The cluster service principal profile. | ServicePrincipalProfile_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| workerProfiles | The cluster worker profiles. | WorkerProfile_STATUS[] Optional |
| workerProfilesStatus | The cluster worker profiles status. | WorkerProfile_STATUS[] Optional |
OpenShiftClusterList
Generator information: - Generated from: /redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/redhatopenshift.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | OpenShiftCluster[] Optional |
OpenShiftCluster_Spec
Used by: OpenShiftCluster.
| Property | Description | Type |
|---|---|---|
| apiserverProfile | The cluster API server profile. | APIServerProfile Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clusterProfile | The cluster profile. | ClusterProfile Optional |
| ingressProfiles | The cluster ingress profiles. | IngressProfile[] Optional |
| location | The geo-location where the resource lives | string Required |
| masterProfile | The cluster master profile. | MasterProfile Optional |
| networkProfile | The cluster network profile. | NetworkProfile Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | OpenShiftClusterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| servicePrincipalProfile | The cluster service principal profile. | ServicePrincipalProfile Optional |
| tags | Resource tags. | map[string]string Optional |
| workerProfiles | The cluster worker profiles. | WorkerProfile[] Optional |
OpenShiftCluster_STATUS
OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
Used by: OpenShiftCluster.
| Property | Description | Type |
|---|---|---|
| apiserverProfile | The cluster API server profile. | APIServerProfile_STATUS Optional |
| clusterProfile | The cluster profile. | ClusterProfile_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| consoleProfile | The console profile. | ConsoleProfile_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| ingressProfiles | The cluster ingress profiles. | IngressProfile_STATUS[] Optional |
| location | The geo-location where the resource lives | string Optional |
| masterProfile | The cluster master profile. | MasterProfile_STATUS Optional |
| name | The name of the resource | string Optional |
| networkProfile | The cluster network profile. | NetworkProfile_STATUS Optional |
| provisioningState | The cluster provisioning state. | ProvisioningState_STATUS Optional |
| servicePrincipalProfile | The cluster service principal profile. | ServicePrincipalProfile_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| workerProfiles | The cluster worker profiles. | WorkerProfile_STATUS[] Optional |
| workerProfilesStatus | The cluster worker profiles status. | WorkerProfile_STATUS[] Optional |
APIServerProfile
APIServerProfile represents an API server profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| visibility | API server visibility. | Visibility Optional |
APIServerProfile_STATUS
APIServerProfile represents an API server profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| ip | The IP of the cluster API server. | string Optional |
| url | The URL to access the cluster API server. | string Optional |
| visibility | API server visibility. | Visibility_STATUS Optional |
ClusterProfile
ClusterProfile represents a cluster profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| domain | The domain for the cluster. | string Optional |
| fipsValidatedModules | If FIPS validated crypto modules are used | FipsValidatedModules Optional |
| pullSecret | The pull secret for the cluster. | genruntime.SecretReference Optional |
| resourceGroupId | The ID of the cluster resource group. | string Optional |
| version | The version of the cluster. | string Optional |
ClusterProfile_STATUS
ClusterProfile represents a cluster profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| domain | The domain for the cluster. | string Optional |
| fipsValidatedModules | If FIPS validated crypto modules are used | FipsValidatedModules_STATUS Optional |
| resourceGroupId | The ID of the cluster resource group. | string Optional |
| version | The version of the cluster. | string Optional |
ConsoleProfile_STATUS
ConsoleProfile represents a console profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| url | The URL to access the cluster console. | string Optional |
IngressProfile
IngressProfile represents an ingress profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| name | The ingress profile name. | string Optional |
| visibility | Ingress visibility. | Visibility Optional |
IngressProfile_STATUS
IngressProfile represents an ingress profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| ip | The IP of the ingress. | string Optional |
| name | The ingress profile name. | string Optional |
| visibility | Ingress visibility. | Visibility_STATUS Optional |
MasterProfile
MasterProfile represents a master profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| diskEncryptionSetReference | The resource ID of an associated DiskEncryptionSet, if applicable. | genruntime.ResourceReference Optional |
| encryptionAtHost | Whether master virtual machines are encrypted at host. | EncryptionAtHost Optional |
| subnetReference | The Azure resource ID of the master subnet. | genruntime.ResourceReference Optional |
| vmSize | The size of the master VMs. | string Optional |
MasterProfile_STATUS
MasterProfile represents a master profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| diskEncryptionSetId | The resource ID of an associated DiskEncryptionSet, if applicable. | string Optional |
| encryptionAtHost | Whether master virtual machines are encrypted at host. | EncryptionAtHost_STATUS Optional |
| subnetId | The Azure resource ID of the master subnet. | string Optional |
| vmSize | The size of the master VMs. | string Optional |
NetworkProfile
NetworkProfile represents a network profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| loadBalancerProfile | The cluster load balancer profile. | LoadBalancerProfile Optional |
| outboundType | The OutboundType used for egress traffic. | OutboundType Optional |
| podCidr | The CIDR used for OpenShift/Kubernetes Pods. | string Optional |
| preconfiguredNSG | Specifies whether subnets are pre-attached with an NSG | PreconfiguredNSG Optional |
| serviceCidr | The CIDR used for OpenShift/Kubernetes Services. | string Optional |
NetworkProfile_STATUS
NetworkProfile represents a network profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| loadBalancerProfile | The cluster load balancer profile. | LoadBalancerProfile_STATUS Optional |
| outboundType | The OutboundType used for egress traffic. | OutboundType_STATUS Optional |
| podCidr | The CIDR used for OpenShift/Kubernetes Pods. | string Optional |
| preconfiguredNSG | Specifies whether subnets are pre-attached with an NSG | PreconfiguredNSG_STATUS Optional |
| serviceCidr | The CIDR used for OpenShift/Kubernetes Services. | string Optional |
OpenShiftClusterOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ProvisioningState_STATUS
ProvisioningState represents a provisioning state.
Used by: OpenShiftCluster_STATUS.
| Value | Description |
|---|---|
| “AdminUpdating” | |
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
ServicePrincipalProfile
ServicePrincipalProfile represents a service principal profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID used for the cluster. | string Optional |
| clientIdFromConfig | The client ID used for the cluster. | genruntime.ConfigMapReference Optional |
| clientSecret | The client secret used for the cluster. | genruntime.SecretReference Optional |
ServicePrincipalProfile_STATUS
ServicePrincipalProfile represents a service principal profile.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID used for the cluster. | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
WorkerProfile
WorkerProfile represents a worker profile.
Used by: OpenShiftCluster_Spec.
| Property | Description | Type |
|---|---|---|
| count | The number of worker VMs. | int Optional |
| diskEncryptionSetReference | The resource ID of an associated DiskEncryptionSet, if applicable. | genruntime.ResourceReference Optional |
| diskSizeGB | The disk size of the worker VMs. | int Optional |
| encryptionAtHost | Whether master virtual machines are encrypted at host. | EncryptionAtHost Optional |
| name | The worker profile name. | string Optional |
| subnetReference | The Azure resource ID of the worker subnet. | genruntime.ResourceReference Optional |
| vmSize | The size of the worker VMs. | string Optional |
WorkerProfile_STATUS
WorkerProfile represents a worker profile.
Used by: OpenShiftCluster_STATUS, and OpenShiftCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| count | The number of worker VMs. | int Optional |
| diskEncryptionSetId | The resource ID of an associated DiskEncryptionSet, if applicable. | string Optional |
| diskSizeGB | The disk size of the worker VMs. | int Optional |
| encryptionAtHost | Whether master virtual machines are encrypted at host. | EncryptionAtHost_STATUS Optional |
| name | The worker profile name. | string Optional |
| subnetId | The Azure resource ID of the worker subnet. | string Optional |
| vmSize | The size of the worker VMs. | string Optional |
EncryptionAtHost
EncryptionAtHost represents encryption at host state
Used by: MasterProfile, and WorkerProfile.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
EncryptionAtHost_STATUS
EncryptionAtHost represents encryption at host state
Used by: MasterProfile_STATUS, and WorkerProfile_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
FipsValidatedModules
FipsValidatedModules determines if FIPS is used.
Used by: ClusterProfile.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
FipsValidatedModules_STATUS
FipsValidatedModules determines if FIPS is used.
Used by: ClusterProfile_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
LoadBalancerProfile
LoadBalancerProfile represents the profile of the cluster public load balancer.
Used by: NetworkProfile.
| Property | Description | Type |
|---|---|---|
| managedOutboundIps | The desired managed outbound IPs for the cluster public load balancer. | ManagedOutboundIPs Optional |
LoadBalancerProfile_STATUS
LoadBalancerProfile represents the profile of the cluster public load balancer.
Used by: NetworkProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| effectiveOutboundIps | The list of effective outbound IP addresses of the public load balancer. | EffectiveOutboundIP_STATUS[] Optional |
| managedOutboundIps | The desired managed outbound IPs for the cluster public load balancer. | ManagedOutboundIPs_STATUS Optional |
OutboundType
The outbound routing strategy used to provide your cluster egress to the internet.
Used by: NetworkProfile.
| Value | Description |
|---|---|
| “Loadbalancer” | |
| “UserDefinedRouting” |
OutboundType_STATUS
The outbound routing strategy used to provide your cluster egress to the internet.
Used by: NetworkProfile_STATUS.
| Value | Description |
|---|---|
| “Loadbalancer” | |
| “UserDefinedRouting” |
PreconfiguredNSG
PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
Used by: NetworkProfile.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
PreconfiguredNSG_STATUS
PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
Used by: NetworkProfile_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
Visibility
Visibility represents visibility.
Used by: APIServerProfile, and IngressProfile.
| Value | Description |
|---|---|
| “Private” | |
| “Public” |
Visibility_STATUS
Visibility represents visibility.
Used by: APIServerProfile_STATUS, and IngressProfile_STATUS.
| Value | Description |
|---|---|
| “Private” | |
| “Public” |
EffectiveOutboundIP_STATUS
EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.
Used by: LoadBalancerProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The fully qualified Azure resource id of an IP address resource. | string Optional |
ManagedOutboundIPs
ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
Used by: LoadBalancerProfile.
| Property | Description | Type |
|---|---|---|
| count | Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1. | int Optional |
ManagedOutboundIPs_STATUS
ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
Used by: LoadBalancerProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| count | Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1. | int Optional |