Open Shift Managed Clusters - Create Or Update

Creates or updates an OpenShift managed cluster.
Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters/{resourceName}?api-version=2019-04-30

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group.

resourceName
path True
  • string

The name of the OpenShift managed cluster resource.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Request Body

Name Required Type Description
location True
  • string

Resource location

properties.openShiftVersion True
  • string

Version of OpenShift specified when creating the cluster.

plan

Define the resource plan as required by ARM for billing purposes

properties.agentPoolProfiles

Configuration of OpenShift cluster VMs.

properties.authProfile

Configures OpenShift authentication.

properties.masterPoolProfile

Configuration for OpenShift master VMs.

properties.networkProfile

Configuration for OpenShift networking.

properties.routerProfiles

Configuration for OpenShift router(s).

tags
  • object

Resource tags

Responses

Name Type Description
200 OK

OK

201 Created

Created

Other Status Codes

Error response describing why the operation failed. If the cluster 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

Create/Update OpenShift Managed Cluster

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/openShiftManagedClusters/clustername1?api-version=2019-04-30
{
  "location": "location1",
  "tags": {
    "tier": "production",
    "archv2": ""
  },
  "properties": {
    "openShiftVersion": "v3.11",
    "networkProfile": {
      "vnetCidr": "10.0.0.0/8"
    },
    "masterPoolProfile": {
      "name": "master",
      "count": 3,
      "vmSize": "Standard_D4s_v3",
      "osType": "Linux",
      "subnetCidr": "10.0.0.0/24"
    },
    "agentPoolProfiles": [
      {
        "name": "infra",
        "role": "infra",
        "count": 2,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      },
      {
        "name": "compute",
        "role": "compute",
        "count": 4,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      }
    ],
    "routerProfiles": [
      {
        "name": "default"
      }
    ],
    "authProfile": {
      "identityProviders": [
        {
          "name": "Azure AD",
          "provider": {
            "kind": "AADIdentityProvider",
            "clientId": "clientId",
            "secret": "secret",
            "tenantId": "tenantId",
            "customerAdminGroupId": "customerAdminGroupId"
          }
        }
      ]
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/openShiftManagedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/OpenShiftManagedClusters",
  "properties": {
    "provisioningState": "Updating",
    "openShiftVersion": "v3.11",
    "clusterVersion": "osa.1",
    "fqdn": "df9337748a4b.location1.cloudapp.azure.com",
    "publicHostname": "openshift.1225bdf9337748a4bd3a.location1.azmosa.io",
    "networkProfile": {
      "vnetCidr": "10.0.0.0/8"
    },
    "masterPoolProfile": {
      "count": 3,
      "vmSize": "Standard_D4s_v3",
      "subnetCidr": "10.0.0.0/24"
    },
    "agentPoolProfiles": [
      {
        "name": "infra",
        "role": "infra",
        "count": 2,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      },
      {
        "name": "compute",
        "role": "compute",
        "count": 4,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      }
    ],
    "routerProfiles": [
      {
        "name": "default",
        "fqdn": "osa2925bdf9337748f4bd3b.location1.cloudapp.azure.com",
        "publicSubdomain": "apps.bc309ee87c164153871c.location1.azmosa.io"
      }
    ],
    "authProfile": {
      "identityProviders": [
        {
          "name": "Azure AD",
          "provider": {
            "kind": "AADIdentityProvider",
            "clientId": "clientId",
            "tenantId": "tenantId",
            "customerAdminGroupId": "customerAdminGroupId"
          }
        }
      ]
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/openShiftManagedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/OpenShiftManagedClusters",
  "properties": {
    "provisioningState": "Creating",
    "openShiftVersion": "v3.11",
    "clusterVersion": "osa.1",
    "fqdn": "df9337748a4b.location1.cloudapp.azure.com",
    "networkProfile": {
      "vnetCidr": "10.0.0.0/8"
    },
    "masterPoolProfile": {
      "name": "master",
      "count": 3,
      "vmSize": "Standard_D4s_v3",
      "osType": "Linux",
      "subnetCidr": "10.0.0.0/24"
    },
    "agentPoolProfiles": [
      {
        "name": "infra",
        "role": "infra",
        "count": 2,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      },
      {
        "name": "compute",
        "role": "compute",
        "count": 4,
        "vmSize": "Standard_D4s_v3",
        "osType": "Linux",
        "subnetCidr": "10.0.0.0/24"
      }
    ],
    "routerProfiles": [
      {
        "name": "default"
      }
    ],
    "authProfile": {
      "identityProviders": [
        {
          "name": "Azure AD",
          "provider": {
            "kind": "AADIdentityProvider",
            "clientId": "clientId",
            "tenantId": "tenantId",
            "customerAdminGroupId": "customerAdminGroupId"
          }
        }
      ]
    }
  }
}

Definitions

CloudError

An error response from the Container service.

CloudErrorBody

An error response from the Container service.

NetworkProfile

Represents the OpenShift networking configuration

OpenShiftAgentPoolProfileRole

OpenShiftAgentPoolProfileRole represents the role of the AgentPoolProfile.

OpenShiftContainerServiceVMSize

Size of OpenShift VMs.

OpenShiftManagedCluster

OpenShift Managed cluster.

OpenShiftManagedClusterAADIdentityProvider

Defines the Identity provider for MS AAD.

OpenShiftManagedClusterAgentPoolProfile

Defines the configuration of the OpenShift cluster VMs.

OpenShiftManagedClusterAuthProfile

Defines all possible authentication profiles for the OpenShift cluster.

OpenShiftManagedClusterIdentityProvider

Defines the configuration of the identity providers to be used in the OpenShift cluster.

OpenShiftManagedClusterMasterPoolProfile

OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs.

OpenShiftRouterProfile

Represents an OpenShift router

OSType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

PurchasePlan

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

CloudError

An error response from the Container service.

Name Type Description
error

Details about the error.

CloudErrorBody

An error response from the Container service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

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.

NetworkProfile

Represents the OpenShift networking configuration

Name Type Description
peerVnetId
  • string

CIDR of the Vnet to peer.

vnetCidr
  • string

CIDR for the OpenShift Vnet.

vnetId
  • string

ID of the Vnet created for OSA cluster.

OpenShiftAgentPoolProfileRole

OpenShiftAgentPoolProfileRole represents the role of the AgentPoolProfile.

Name Type Description
compute
  • string
infra
  • string

OpenShiftContainerServiceVMSize

Size of OpenShift VMs.

Name Type Description
Standard_D16s_v3
  • string
Standard_D2s_v3
  • string
Standard_D32s_v3
  • string
Standard_D4s_v3
  • string
Standard_D64s_v3
  • string
Standard_D8s_v3
  • string
Standard_DS12_v2
  • string
Standard_DS13_v2
  • string
Standard_DS14_v2
  • string
Standard_DS15_v2
  • string
Standard_DS4_v2
  • string
Standard_DS5_v2
  • string
Standard_E16s_v3
  • string
Standard_E20s_v3
  • string
Standard_E32s_v3
  • string
Standard_E4s_v3
  • string
Standard_E64s_v3
  • string
Standard_E8s_v3
  • string
Standard_F16s
  • string
Standard_F16s_v2
  • string
Standard_F32s_v2
  • string
Standard_F64s_v2
  • string
Standard_F72s_v2
  • string
Standard_F8s
  • string
Standard_F8s_v2
  • string
Standard_GS2
  • string
Standard_GS3
  • string
Standard_GS4
  • string
Standard_GS5
  • string
Standard_L16s
  • string
Standard_L32s
  • string
Standard_L4s
  • string
Standard_L8s
  • string

OpenShiftManagedCluster

OpenShift Managed cluster.

Name Type Description
id
  • string

Resource Id

location
  • string

Resource location

name
  • string

Resource name

plan

Define the resource plan as required by ARM for billing purposes

properties.agentPoolProfiles

Configuration of OpenShift cluster VMs.

properties.authProfile

Configures OpenShift authentication.

properties.clusterVersion
  • string

Version of OpenShift specified when creating the cluster.

properties.fqdn
  • string

Service generated FQDN for OpenShift API server loadbalancer internal hostname.

properties.masterPoolProfile

Configuration for OpenShift master VMs.

properties.networkProfile

Configuration for OpenShift networking.

properties.openShiftVersion
  • string

Version of OpenShift specified when creating the cluster.

properties.provisioningState
  • string

The current deployment or provisioning state, which only appears in the response.

properties.publicHostname
  • string

Service generated FQDN for OpenShift API server.

properties.routerProfiles

Configuration for OpenShift router(s).

tags
  • object

Resource tags

type
  • string

Resource type

OpenShiftManagedClusterAADIdentityProvider

Defines the Identity provider for MS AAD.

Name Type Description
clientId
  • string

The clientId password associated with the provider.

customerAdminGroupId
  • string

The groupId to be granted cluster admin role.

kind string:
  • AADIdentityProvider

The kind of the provider.

secret
  • string

The secret password associated with the provider.

tenantId
  • string

The tenantId associated with the provider.

OpenShiftManagedClusterAgentPoolProfile

Defines the configuration of the OpenShift cluster VMs.

Name Type Description
count
  • integer

Number of agents (VMs) to host docker containers.

name
  • string

Unique name of the pool profile in the context of the subscription and resource group.

osType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

role

Define the role of the AgentPoolProfile.

subnetCidr
  • string

Subnet CIDR for the peering.

vmSize

Size of agent VMs.

OpenShiftManagedClusterAuthProfile

Defines all possible authentication profiles for the OpenShift cluster.

Name Type Description
identityProviders

Type of authentication profile to use.

OpenShiftManagedClusterIdentityProvider

Defines the configuration of the identity providers to be used in the OpenShift cluster.

Name Type Description
name
  • string

Name of the provider.

provider OpenShiftManagedClusterBaseIdentityProvider:

Configuration of the provider.

OpenShiftManagedClusterMasterPoolProfile

OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs.

Name Type Description
count
  • integer

Number of masters (VMs) to host docker containers. The default value is 3.

name
  • string

Unique name of the master pool profile in the context of the subscription and resource group.

osType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

subnetCidr
  • string

Subnet CIDR for the peering.

vmSize

Size of agent VMs.

OpenShiftRouterProfile

Represents an OpenShift router

Name Type Description
fqdn
  • string

Auto-allocated FQDN for the OpenShift router.

name
  • string

Name of the router profile.

publicSubdomain
  • string

DNS subdomain for OpenShift router.

OSType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

Name Type Description
Linux
  • string
Windows
  • string

PurchasePlan

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Name Type Description
name
  • string

The plan ID.

product
  • string

Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

promotionCode
  • string

The promotion code.

publisher
  • string

The plan ID.