Microsoft.RedHatOpenShift (stable:2020-04-30)

2025/10/23 • 8 new, 8 deleted 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 ,
]
,
}
,
}
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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 ,
]
,
}
,
}
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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 ,
]
,
}
,
}
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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_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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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_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. ,
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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. ,
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 ,
]
,
}
,
}
Operations_List (removed)
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 ,
]
,
}
,
}
OpenShiftClusters_List (removed)
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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 ,
]
,
}
,
}
OpenShiftClusters_ListByResourceGroup (removed)
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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 ,
]
,
}
,
}
OpenShiftClusters_Get (removed)
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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_CreateOrUpdate (removed)
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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_Delete (removed)
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. ,
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 (removed)
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. ,
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 (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The cluster provisioning state (immutable). ,
Enum:
{
AdminUpdating: 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 (immutable). ,
Required: False ,
}
string ,
domain:
{
Description: The domain for the cluster (immutable). ,
Required: False ,
}
string ,
version:
{
Description: The version of the cluster (immutable). ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The ID of the cluster resource group (immutable). ,
Required: False ,
}
string ,
}
,
consoleProfile:
{
Description: The console profile. ,
Required: False ,
}
{
url:
{
Description: The URL to access the cluster console (immutable). ,
Required: False ,
}
string ,
}
,
servicePrincipalProfile:
{
Description: The cluster service principal profile. ,
Required: False ,
}
{
clientId:
{
Description: The client ID used for the cluster (immutable). ,
Required: False ,
}
string ,
clientSecret:
{
Description: The client secret used for the cluster (immutable). ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The cluster network profile. ,
Required: False ,
}
{
podCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Pods (immutable). ,
Required: False ,
}
string ,
serviceCidr:
{
Description: The CIDR used for OpenShift/Kubernetes Services (immutable). ,
Required: False ,
}
string ,
}
,
masterProfile:
{
Description: The cluster master profile. ,
Required: False ,
}
{
vmSize:
{
Description: The size of the master VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Description: The Azure resource ID of the master subnet (immutable). ,
Required: False ,
}
string ,
}
,
workerProfiles:
{
Description: The cluster worker profiles. ,
Required: False ,
}
[
{
name:
{
Description: The worker profile name. Must be "worker" (immutable). ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the worker VMs (immutable). ,
Enum:
{
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The disk size of the worker VMs. Must be 128 or greater (immutable). ,
Required: False ,
}
integer ,
subnetId:
{
Description: The Azure resource ID of the worker subnet (immutable). ,
Required: False ,
}
string ,
count:
{
Description: The number of worker VMs. Must be between 3 and 20 (immutable). ,
Required: False ,
}
integer ,
}
,
]
,
apiserverProfile:
{
Description: The cluster API server profile. ,
Required: False ,
}
{
visibility:
{
Description: API server visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: The URL to access the cluster API server (immutable). ,
Required: False ,
}
string ,
ip:
{
Description: The IP of the cluster API server (immutable). ,
Required: False ,
}
string ,
}
,
ingressProfiles:
{
Description: The cluster ingress profiles. ,
Required: False ,
}
[
{
name:
{
Description: The ingress profile name. Must be "default" (immutable). ,
Required: False ,
}
string ,
visibility:
{
Description: Ingress visibility (immutable). ,
Enum:
{
Private: No description available. ,
Public: No description available. ,
}
,
Required: False ,
}
enum ,
ip:
{
Description: The IP of the ingress (immutable). ,
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 (removed)
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. ,
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 ,
]
,
}
,
}