Open Shift Clusters - Create Or Update

Service:

Red Hat OpenShift

API Version:

2023-11-22

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.
The operation returns properties of a OpenShift cluster.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}?api-version=2023-11-22

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
resourceName	path	True	string	The name of the OpenShift cluster resource.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.apiserverProfile		APIServerProfile	The cluster API server profile.
properties.clusterProfile		ClusterProfile	The cluster profile.
properties.consoleProfile		ConsoleProfile	The console profile.
properties.ingressProfiles		IngressProfile[]	The cluster ingress profiles.
properties.masterProfile		MasterProfile	The cluster master profile.
properties.networkProfile		NetworkProfile	The cluster network profile.
properties.provisioningState		ProvisioningState	The cluster provisioning state.
properties.servicePrincipalProfile		ServicePrincipalProfile	The cluster service principal profile.
properties.workerProfiles		WorkerProfile[]	The cluster worker profiles.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	OpenShiftCluster	OK
201 Created	OpenShiftCluster	Created
Other Status Codes	CloudError	Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/openShiftClusters/resourceName?api-version=2023-11-22

{
  "location": "location",
  "tags": {
    "key": "value"
  },
  "properties": {
    "clusterProfile": {
      "pullSecret": "{\"auths\":{\"registry.connect.redhat.com\":{\"auth\":\"\"},\"registry.redhat.io\":{\"auth\":\"\"}}}",
      "domain": "cluster.location.aroapp.io",
      "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup",
      "fipsValidatedModules": "Enabled"
    },
    "consoleProfile": {},
    "servicePrincipalProfile": {
      "clientId": "clientId",
      "clientSecret": "clientSecret"
    },
    "networkProfile": {
      "podCidr": "10.128.0.0/14",
      "serviceCidr": "172.30.0.0/16",
      "loadBalancerProfile": {
        "managedOutboundIps": {
          "count": 1
        }
      },
      "preconfiguredNSG": "Disabled"
    },
    "masterProfile": {
      "vmSize": "Standard_D8s_v3",
      "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master",
      "encryptionAtHost": "Enabled"
    },
    "workerProfiles": [
      {
        "name": "worker",
        "vmSize": "Standard_D2s_v3",
        "diskSizeGB": 128,
        "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
        "count": 3
      }
    ],
    "apiserverProfile": {
      "visibility": "Public"
    },
    "ingressProfiles": [
      {
        "name": "default",
        "visibility": "Public"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.redhatopenshift.models.ApiServerProfile;
import com.azure.resourcemanager.redhatopenshift.models.ClusterProfile;
import com.azure.resourcemanager.redhatopenshift.models.ConsoleProfile;
import com.azure.resourcemanager.redhatopenshift.models.EncryptionAtHost;
import com.azure.resourcemanager.redhatopenshift.models.FipsValidatedModules;
import com.azure.resourcemanager.redhatopenshift.models.IngressProfile;
import com.azure.resourcemanager.redhatopenshift.models.LoadBalancerProfile;
import com.azure.resourcemanager.redhatopenshift.models.ManagedOutboundIPs;
import com.azure.resourcemanager.redhatopenshift.models.MasterProfile;
import com.azure.resourcemanager.redhatopenshift.models.NetworkProfile;
import com.azure.resourcemanager.redhatopenshift.models.PreconfiguredNsg;
import com.azure.resourcemanager.redhatopenshift.models.ServicePrincipalProfile;
import com.azure.resourcemanager.redhatopenshift.models.Visibility;
import com.azure.resourcemanager.redhatopenshift.models.WorkerProfile;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for OpenShiftClusters CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/
     * examples/OpenShiftClusters_CreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates a OpenShift cluster with the specified subscription, resource group and resource
     * name.
     * 
     * @param manager Entry point to RedHatOpenShiftManager.
     */
    public static void createsOrUpdatesAOpenShiftClusterWithTheSpecifiedSubscriptionResourceGroupAndResourceName(
        com.azure.resourcemanager.redhatopenshift.RedHatOpenShiftManager manager) {
        manager.openShiftClusters().define("resourceName").withRegion("location")
            .withExistingResourceGroup("resourceGroup").withTags(mapOf("key", "fakeTokenPlaceholder"))
            .withClusterProfile(
                new ClusterProfile().withPullSecret("fakeTokenPlaceholder").withDomain("cluster.location.aroapp.io")
                    .withResourceGroupId("/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup")
                    .withFipsValidatedModules(FipsValidatedModules.ENABLED))
            .withConsoleProfile(new ConsoleProfile())
            .withServicePrincipalProfile(
                new ServicePrincipalProfile().withClientId("clientId").withClientSecret("fakeTokenPlaceholder"))
            .withNetworkProfile(new NetworkProfile().withPodCidr("10.128.0.0/14").withServiceCidr("172.30.0.0/16")
                .withLoadBalancerProfile(
                    new LoadBalancerProfile().withManagedOutboundIps(new ManagedOutboundIPs().withCount(1)))
                .withPreconfiguredNsg(PreconfiguredNsg.DISABLED))
            .withMasterProfile(new MasterProfile().withVmSize("Standard_D8s_v3").withSubnetId(
                "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master")
                .withEncryptionAtHost(EncryptionAtHost.ENABLED))
            .withWorkerProfiles(Arrays.asList(new WorkerProfile().withName("worker").withVmSize("Standard_D2s_v3")
                .withDiskSizeGB(128)
                .withSubnetId(
                    "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker")
                .withCount(3)))
            .withApiserverProfile(new ApiServerProfile().withVisibility(Visibility.PUBLIC)).withIngressProfiles(
                Arrays.asList(new IngressProfile().withName("default").withVisibility(Visibility.PUBLIC)))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.redhatopenshift import AzureRedHatOpenShiftClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redhatopenshift
# USAGE
    python open_shift_clusters_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureRedHatOpenShiftClient(
        credential=DefaultAzureCredential(),
        subscription_id="subscriptionId",
    )

    response = client.open_shift_clusters.begin_create_or_update(
        resource_group_name="resourceGroup",
        resource_name="resourceName",
        parameters={
            "location": "location",
            "properties": {
                "apiserverProfile": {"visibility": "Public"},
                "clusterProfile": {
                    "domain": "cluster.location.aroapp.io",
                    "fipsValidatedModules": "Enabled",
                    "pullSecret": '{"auths":{"registry.connect.redhat.com":{"auth":""},"registry.redhat.io":{"auth":""}}}',
                    "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup",
                },
                "consoleProfile": {},
                "ingressProfiles": [{"name": "default", "visibility": "Public"}],
                "masterProfile": {
                    "encryptionAtHost": "Enabled",
                    "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master",
                    "vmSize": "Standard_D8s_v3",
                },
                "networkProfile": {
                    "loadBalancerProfile": {"managedOutboundIps": {"count": 1}},
                    "podCidr": "10.128.0.0/14",
                    "preconfiguredNSG": "Disabled",
                    "serviceCidr": "172.30.0.0/16",
                },
                "servicePrincipalProfile": {"clientId": "clientId", "clientSecret": "clientSecret"},
                "workerProfiles": [
                    {
                        "count": 3,
                        "diskSizeGB": 128,
                        "name": "worker",
                        "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
                        "vmSize": "Standard_D2s_v3",
                    }
                ],
            },
            "tags": {"key": "value"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/examples/OpenShiftClusters_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armredhatopenshift_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redhatopenshift/armredhatopenshift"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c1cea38fb7e5cec9afe223a2ed15cbe2fbeecbdb/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/examples/OpenShiftClusters_CreateOrUpdate.json
func ExampleOpenShiftClustersClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredhatopenshift.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewOpenShiftClustersClient().BeginCreateOrUpdate(ctx, "resourceGroup", "resourceName", armredhatopenshift.OpenShiftCluster{
		Location: to.Ptr("location"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Properties: &armredhatopenshift.OpenShiftClusterProperties{
			ApiserverProfile: &armredhatopenshift.APIServerProfile{
				Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
			},
			ClusterProfile: &armredhatopenshift.ClusterProfile{
				Domain:               to.Ptr("cluster.location.aroapp.io"),
				FipsValidatedModules: to.Ptr(armredhatopenshift.FipsValidatedModulesEnabled),
				PullSecret:           to.Ptr("{\"auths\":{\"registry.connect.redhat.com\":{\"auth\":\"\"},\"registry.redhat.io\":{\"auth\":\"\"}}}"),
				ResourceGroupID:      to.Ptr("/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"),
			},
			ConsoleProfile: &armredhatopenshift.ConsoleProfile{},
			IngressProfiles: []*armredhatopenshift.IngressProfile{
				{
					Name:       to.Ptr("default"),
					Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
				}},
			MasterProfile: &armredhatopenshift.MasterProfile{
				EncryptionAtHost: to.Ptr(armredhatopenshift.EncryptionAtHostEnabled),
				SubnetID:         to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"),
				VMSize:           to.Ptr("Standard_D8s_v3"),
			},
			NetworkProfile: &armredhatopenshift.NetworkProfile{
				LoadBalancerProfile: &armredhatopenshift.LoadBalancerProfile{
					ManagedOutboundIPs: &armredhatopenshift.ManagedOutboundIPs{
						Count: to.Ptr[int32](1),
					},
				},
				PodCidr:          to.Ptr("10.128.0.0/14"),
				PreconfiguredNSG: to.Ptr(armredhatopenshift.PreconfiguredNSGDisabled),
				ServiceCidr:      to.Ptr("172.30.0.0/16"),
			},
			ServicePrincipalProfile: &armredhatopenshift.ServicePrincipalProfile{
				ClientID:     to.Ptr("clientId"),
				ClientSecret: to.Ptr("clientSecret"),
			},
			WorkerProfiles: []*armredhatopenshift.WorkerProfile{
				{
					Name:       to.Ptr("worker"),
					Count:      to.Ptr[int32](3),
					DiskSizeGB: to.Ptr[int32](128),
					SubnetID:   to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
					VMSize:     to.Ptr("Standard_D2s_v3"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OpenShiftCluster = armredhatopenshift.OpenShiftCluster{
	// 	Name: to.Ptr("resourceName"),
	// 	Type: to.Ptr("Microsoft.RedHatOpenShift/OpenShiftClusters"),
	// 	ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName"),
	// 	SystemData: &armredhatopenshift.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-03T01:01:01.107Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armredhatopenshift.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-03T01:01:01.107Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armredhatopenshift.CreatedByTypeApplication),
	// 	},
	// 	Location: to.Ptr("location"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armredhatopenshift.OpenShiftClusterProperties{
	// 		ApiserverProfile: &armredhatopenshift.APIServerProfile{
	// 			IP: to.Ptr("1.2.3.4"),
	// 			URL: to.Ptr("https://api.cluster.location.aroapp.io:6443/"),
	// 			Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
	// 		},
	// 		ClusterProfile: &armredhatopenshift.ClusterProfile{
	// 			Domain: to.Ptr("cluster.location.aroapp.io"),
	// 			ResourceGroupID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"),
	// 			Version: to.Ptr("4.11.0"),
	// 		},
	// 		ConsoleProfile: &armredhatopenshift.ConsoleProfile{
	// 			URL: to.Ptr("https://console-openshift-console.apps.cluster.location.aroapp.io/"),
	// 		},
	// 		IngressProfiles: []*armredhatopenshift.IngressProfile{
	// 			{
	// 				Name: to.Ptr("default"),
	// 				IP: to.Ptr("1.2.3.4"),
	// 				Visibility: to.Ptr(armredhatopenshift.VisibilityPublic),
	// 		}},
	// 		MasterProfile: &armredhatopenshift.MasterProfile{
	// 			SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"),
	// 			VMSize: to.Ptr("Standard_D8s_v3"),
	// 		},
	// 		NetworkProfile: &armredhatopenshift.NetworkProfile{
	// 			PodCidr: to.Ptr("10.128.0.0/14"),
	// 			PreconfiguredNSG: to.Ptr(armredhatopenshift.PreconfiguredNSGDisabled),
	// 			ServiceCidr: to.Ptr("172.30.0.0/16"),
	// 		},
	// 		ProvisioningState: to.Ptr(armredhatopenshift.ProvisioningStateSucceeded),
	// 		ServicePrincipalProfile: &armredhatopenshift.ServicePrincipalProfile{
	// 			ClientID: to.Ptr("clientId"),
	// 		},
	// 		WorkerProfiles: []*armredhatopenshift.WorkerProfile{
	// 			{
	// 				Name: to.Ptr("worker"),
	// 				Count: to.Ptr[int32](3),
	// 				DiskSizeGB: to.Ptr[int32](128),
	// 				SubnetID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker"),
	// 				VMSize: to.Ptr("Standard_D2s_v3"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureRedHatOpenShiftClient } = require("@azure/arm-redhatopenshift");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The operation returns properties of a OpenShift cluster.
 *
 * @summary The operation returns properties of a OpenShift cluster.
 * x-ms-original-file: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/examples/OpenShiftClusters_CreateOrUpdate.json
 */
async function createsOrUpdatesAOpenShiftClusterWithTheSpecifiedSubscriptionResourceGroupAndResourceName() {
  const subscriptionId = process.env["REDHATOPENSHIFT_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["REDHATOPENSHIFT_RESOURCE_GROUP"] || "resourceGroup";
  const resourceName = "resourceName";
  const parameters = {
    apiserverProfile: { visibility: "Public" },
    clusterProfile: {
      domain: "cluster.location.aroapp.io",
      fipsValidatedModules: "Enabled",
      pullSecret:
        '{"auths":{"registry.connect.redhat.com":{"auth":""},"registry.redhat.io":{"auth":""}}}',
      resourceGroupId: "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup",
    },
    consoleProfile: {},
    ingressProfiles: [{ name: "default", visibility: "Public" }],
    location: "location",
    masterProfile: {
      encryptionAtHost: "Enabled",
      subnetId:
        "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master",
      vmSize: "Standard_D8s_v3",
    },
    networkProfile: {
      loadBalancerProfile: { managedOutboundIps: { count: 1 } },
      podCidr: "10.128.0.0/14",
      preconfiguredNSG: "Disabled",
      serviceCidr: "172.30.0.0/16",
    },
    servicePrincipalProfile: {
      clientId: "clientId",
      clientSecret: "clientSecret",
    },
    tags: { key: "value" },
    workerProfiles: [
      {
        name: "worker",
        count: 3,
        diskSizeGB: 128,
        subnetId:
          "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
        vmSize: "Standard_D2s_v3",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureRedHatOpenShiftClient(credential, subscriptionId);
  const result = await client.openShiftClusters.beginCreateOrUpdateAndWait(
    resourceGroupName,
    resourceName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName",
  "name": "resourceName",
  "type": "Microsoft.RedHatOpenShift/OpenShiftClusters",
  "location": "location",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-03T01:01:01.1075056Z"
  },
  "tags": {
    "key": "value"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "clusterProfile": {
      "domain": "cluster.location.aroapp.io",
      "version": "4.11.0",
      "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"
    },
    "consoleProfile": {
      "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/"
    },
    "servicePrincipalProfile": {
      "clientId": "clientId"
    },
    "networkProfile": {
      "podCidr": "10.128.0.0/14",
      "serviceCidr": "172.30.0.0/16",
      "preconfiguredNSG": "Disabled"
    },
    "masterProfile": {
      "vmSize": "Standard_D8s_v3",
      "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"
    },
    "workerProfiles": [
      {
        "name": "worker",
        "vmSize": "Standard_D2s_v3",
        "diskSizeGB": 128,
        "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
        "count": 3
      }
    ],
    "apiserverProfile": {
      "visibility": "Public",
      "url": "https://api.cluster.location.aroapp.io:6443/",
      "ip": "1.2.3.4"
    },
    "ingressProfiles": [
      {
        "name": "default",
        "visibility": "Public",
        "ip": "1.2.3.4"
      }
    ]
  }
}

Status code:

201

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName",
  "name": "resourceName",
  "type": "Microsoft.RedHatOpenShift/OpenShiftClusters",
  "location": "location",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-03T01:01:01.1075056Z"
  },
  "tags": {
    "key": "value"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "clusterProfile": {
      "domain": "cluster.location.aroapp.io",
      "version": "4.11.0",
      "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"
    },
    "consoleProfile": {
      "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/"
    },
    "servicePrincipalProfile": {
      "clientId": "clientId"
    },
    "networkProfile": {
      "podCidr": "10.128.0.0/14",
      "serviceCidr": "172.30.0.0/16",
      "preconfiguredNSG": "Disabled"
    },
    "masterProfile": {
      "vmSize": "Standard_D8s_v3",
      "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"
    },
    "workerProfiles": [
      {
        "name": "worker",
        "vmSize": "Standard_D2s_v3",
        "diskSizeGB": 128,
        "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
        "count": 3
      }
    ],
    "apiserverProfile": {
      "visibility": "Public",
      "url": "https://api.cluster.location.aroapp.io:6443/",
      "ip": "1.2.3.4"
    },
    "ingressProfiles": [
      {
        "name": "default",
        "visibility": "Public",
        "ip": "1.2.3.4"
      }
    ]
  }
}

Definitions

Name	Description
APIServerProfile	APIServerProfile represents an API server profile.
CloudError	CloudError represents a cloud error.
CloudErrorBody	CloudErrorBody represents the body of a cloud error.
ClusterProfile	ClusterProfile represents a cluster profile.
ConsoleProfile	ConsoleProfile represents a console profile.
createdByType	The type of identity that created the resource.
EffectiveOutboundIP	EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.
EncryptionAtHost	EncryptionAtHost represents encryption at host state
FipsValidatedModules	FipsValidatedModules determines if FIPS is used.
IngressProfile	IngressProfile represents an ingress profile.
LoadBalancerProfile	LoadBalancerProfile represents the profile of the cluster public load balancer.
ManagedOutboundIPs	ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
MasterProfile	MasterProfile represents a master profile.
NetworkProfile	NetworkProfile represents a network profile.
OpenShiftCluster	OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
OutboundType	The outbound routing strategy used to provide your cluster egress to the internet.
PreconfiguredNSG	PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
ProvisioningState	ProvisioningState represents a provisioning state.
ServicePrincipalProfile	ServicePrincipalProfile represents a service principal profile.
systemData	Metadata pertaining to creation and last modification of the resource.
Visibility	Visibility represents visibility.
WorkerProfile	WorkerProfile represents a worker profile.

APIServerProfile

Object

APIServerProfile represents an API server profile.

Name	Type	Description
ip	string	The IP of the cluster API server.
url	string	The URL to access the cluster API server.
visibility	Visibility	API server visibility.

CloudError

Object

CloudError represents a cloud error.

Name	Type	Description
error	CloudErrorBody	An error response from the service.

CloudErrorBody

Object

CloudErrorBody represents the body of a cloud error.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ClusterProfile

Object

ClusterProfile represents a cluster profile.

Name	Type	Description
domain	string	The domain for the cluster.
fipsValidatedModules	FipsValidatedModules	If FIPS validated crypto modules are used
pullSecret	string	The pull secret for the cluster.
resourceGroupId	string	The ID of the cluster resource group.
version	string	The version of the cluster.

ConsoleProfile

Object

ConsoleProfile represents a console profile.

Name	Type	Description
url	string	The URL to access the cluster console.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EffectiveOutboundIP

Object

EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.

Name	Type	Description
id	string	The fully qualified Azure resource id of an IP address resource.

EncryptionAtHost

Enumeration

EncryptionAtHost represents encryption at host state

Value	Description
Disabled
Enabled

FipsValidatedModules

Enumeration

FipsValidatedModules determines if FIPS is used.

Value	Description
Disabled
Enabled

IngressProfile

Object

IngressProfile represents an ingress profile.

Name	Type	Description
ip	string	The IP of the ingress.
name	string	The ingress profile name.
visibility	Visibility	Ingress visibility.

LoadBalancerProfile

Object

LoadBalancerProfile represents the profile of the cluster public load balancer.

Name	Type	Description
effectiveOutboundIps	EffectiveOutboundIP[]	The list of effective outbound IP addresses of the public load balancer.
managedOutboundIps	ManagedOutboundIPs	The desired managed outbound IPs for the cluster public load balancer.

ManagedOutboundIPs

Object

ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.

Name	Type	Description
count	integer (int32)	Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.

MasterProfile

Object

MasterProfile represents a master profile.

Name	Type	Description
diskEncryptionSetId	string	The resource ID of an associated DiskEncryptionSet, if applicable.
encryptionAtHost	EncryptionAtHost	Whether master virtual machines are encrypted at host.
subnetId	string	The Azure resource ID of the master subnet.
vmSize	string	The size of the master VMs.

NetworkProfile

Object

NetworkProfile represents a network profile.

Name	Type	Description
loadBalancerProfile	LoadBalancerProfile	The cluster load balancer profile.
outboundType	OutboundType	The OutboundType used for egress traffic.
podCidr	string	The CIDR used for OpenShift/Kubernetes Pods.
preconfiguredNSG	PreconfiguredNSG	Specifies whether subnets are pre-attached with an NSG
serviceCidr	string	The CIDR used for OpenShift/Kubernetes Services.

OpenShiftCluster

Object

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.apiserverProfile	APIServerProfile	The cluster API server profile.
properties.clusterProfile	ClusterProfile	The cluster profile.
properties.consoleProfile	ConsoleProfile	The console profile.
properties.ingressProfiles	IngressProfile[]	The cluster ingress profiles.
properties.masterProfile	MasterProfile	The cluster master profile.
properties.networkProfile	NetworkProfile	The cluster network profile.
properties.provisioningState	ProvisioningState	The cluster provisioning state.
properties.servicePrincipalProfile	ServicePrincipalProfile	The cluster service principal profile.
properties.workerProfiles	WorkerProfile[]	The cluster worker profiles.
properties.workerProfilesStatus	WorkerProfile[]	The cluster worker profiles status.
systemData	systemData	The system meta data relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OutboundType

Enumeration

The outbound routing strategy used to provide your cluster egress to the internet.

Value	Description
Loadbalancer
UserDefinedRouting

PreconfiguredNSG

Enumeration

PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets

Value	Description
Disabled
Enabled

ProvisioningState

Enumeration

ProvisioningState represents a provisioning state.

Value	Description
AdminUpdating
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ServicePrincipalProfile

Object

ServicePrincipalProfile represents a service principal profile.

Name	Type	Description
clientId	string	The client ID used for the cluster.
clientSecret	string	The client secret used for the cluster.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Visibility

Enumeration

Visibility represents visibility.

Value	Description
Private
Public

WorkerProfile

Object

WorkerProfile represents a worker profile.

Name	Type	Description
count	integer (int32)	The number of worker VMs.
diskEncryptionSetId	string	The resource ID of an associated DiskEncryptionSet, if applicable.
diskSizeGB	integer (int32)	The disk size of the worker VMs.
encryptionAtHost	EncryptionAtHost	Whether master virtual machines are encrypted at host.
name	string	The worker profile name.
subnetId	string	The Azure resource ID of the worker subnet.
vmSize	string	The size of the worker VMs.