Microsoft.RedHatOpenShift (preview:2024-08-12)

2025/01/23 • 13 new methods

Operations_List (new)
Description :  The operation returns the RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.RedHatOpenShift/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: read, write, delete, listKeys/action, etc. ,
Required: False ,
}
string ,
description:
{
Description: Friendly name of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Sources of requests to this operation. Comma separated list with valid values user or system, e.g. "user,system". ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftVersions_List (new)
Description :  The operation returns the installable OpenShift versions as a string.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/openShiftVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The List of available versions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties for the OpenShiftVersion resource. ,
Required: False ,
}
{
version:
{
Description: Version represents the version to create the cluster at. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Next Link to next operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftVersions_Get (new)
Description :  This operation returns installable OpenShift version as a string.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/openShiftVersions/{openShiftVersion}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
openShiftVersion:
{
Description: The desired version value of the OpenShiftVersion resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties for the OpenShiftVersion resource. ,
Required: False ,
}
{
version:
{
Description: Version represents the version to create the cluster at. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PlatformWorkloadIdentityRoleSets_List (new)
Description :  This operation returns a list of Platform Workload Identity Role Sets as a string
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/platformWorkloadIdentityRoleSets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role sets. ,
Required: False ,
}
[
{
properties:
{
Description: The properties for the PlatformWorkloadIdentityRoleSet resource. ,
Required: False ,
}
{
openShiftVersion:
{
Description: OpenShiftVersion represents the version associated with this set of roles. ,
Required: False ,
}
string ,
platformWorkloadIdentityRoles:
{
Description: PlatformWorkloadIdentityRoles represents the set of roles associated with this version. ,
Required: False ,
}
[
{
operatorName:
{
Description: OperatorName represents the name of the operator that this role is for. ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: RoleDefinitionName represents the name of the role. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: RoleDefinitionID represents the resource ID of the role definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Next Link to next operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PlatformWorkloadIdentityRoleSet_Get (new)
Description :  This operation returns Platform Workload Identity Role Set as a string
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/platformWorkloadIdentityRoleSets/{openShiftMinorVersion}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
openShiftMinorVersion:
{
Description: The desired version value of the PlatformWorkloadIdentityRoleSet resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties for the PlatformWorkloadIdentityRoleSet resource. ,
Required: False ,
}
{
openShiftVersion:
{
Description: OpenShiftVersion represents the version associated with this set of roles. ,
Required: False ,
}
string ,
platformWorkloadIdentityRoles:
{
Description: PlatformWorkloadIdentityRoles represents the set of roles associated with this version. ,
Required: False ,
}
[
{
operatorName:
{
Description: OperatorName represents the name of the operator that this role is for. ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: RoleDefinitionName represents the name of the role. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: RoleDefinitionID represents the resource ID of the role definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_List (new)
Description :  The operation returns properties of each OpenShift cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/openShiftClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of OpenShift clusters. ,
Required: False ,
}
[
{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_ListByResourceGroup (new)
Description :  The operation returns properties of each OpenShift cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of OpenShift clusters. ,
Required: False ,
}
[
{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_Get (new)
Description :  The operation returns properties of a OpenShift cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_CreateOrUpdate (new)
Description :  The operation returns properties of a OpenShift cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The OpenShift cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_Delete (new)
Description :  The operation returns nothing.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_Update (new)
Description :  The operation returns properties of a OpenShift cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The OpenShift cluster resource. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state. ,
Enum:
{
AdminUpdating: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
clusterProfile:
{
Description: The cluster profile. ,
Required: False ,
}
{
pullSecret:
{
Description: The pull secret for the cluster. ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster. ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group. ,
Required: False ,
}
string ,
fipsValidatedModules:
{
Description: If FIPS validated crypto modules are used ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
oidcIssuer:
{
Description: The URL of the managed OIDC issuer in a workload identity cluster. ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console. ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster. ,
Required: False ,
}
string ,
}
,
platformWorkloadIdentityProfile:
{
Description: The workload identity profile. ,
Required: False ,
}
{
upgradeableTo:
{
Description: UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to ,
Required: False ,
}
string ,
platformWorkloadIdentities:
{
Required: False ,
}
object ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods. ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services. ,
Required: False ,
}
string ,
outboundType:
{
Description: The OutboundType used for egress traffic. ,
Enum:
{
Loadbalancer: No description available. ,
UserDefinedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerProfile:
{
Description: The cluster load balancer profile. ,
Required: False ,
}
{
managedOutboundIps:
{
Description: The desired managed outbound IPs for the cluster public load balancer. ,
Required: False ,
}
{
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
effectiveOutboundIps:
{
Description: The list of effective outbound IP addresses of the public load balancer. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource id of an IP address resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preconfiguredNSG:
{
Description: Specifies whether subnets are pre-attached with an NSG ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure resource ID of the master subnet. ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
workerProfilesStatus:
{
Description: The cluster worker profiles status. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The disk size of the worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet. ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionAtHost:
{
Description: Whether master virtual machines are encrypted at host. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSetId:
{
Description: The resource ID of an associated DiskEncryptionSet, if applicable. ,
Required: False ,
}
string ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server. ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server. ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility. ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress. ,
Required: False ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: Identity stores information about the cluster MSI(s) in a workload identity cluster. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_ListAdminCredentials (new)
Description :  The operation returns the admin kubeconfig.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listAdminCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kubeconfig:
{
Description: The base64-encoded kubeconfig file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenShiftClusters_ListCredentials (new)
Description :  The operation returns the credentials.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the OpenShift cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kubeadminUsername:
{
Description: The username for the kubeadmin user. ,
Required: False ,
}
string ,
kubeadminPassword:
{
Description: The password for the kubeadmin user. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}