Microsoft.RedHatOpenShift openShiftClusters 2020-04-30

Bicep resource definition

The openShiftClusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RedHatOpenShift/openShiftClusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    apiserverProfile: {
      ip: 'string'
      url: 'string'
      visibility: 'string'
    }
    clusterProfile: {
      domain: 'string'
      pullSecret: 'string'
      resourceGroupId: 'string'
      version: 'string'
    }
    consoleProfile: {
      url: 'string'
    }
    ingressProfiles: [
      {
        ip: 'string'
        name: 'string'
        visibility: 'string'
      }
    ]
    masterProfile: {
      subnetId: 'string'
      vmSize: 'string'
    }
    networkProfile: {
      podCidr: 'string'
      serviceCidr: 'string'
    }
    provisioningState: 'string'
    servicePrincipalProfile: {
      clientId: 'string'
      clientSecret: 'string'
    }
    workerProfiles: [
      {
        count: int
        diskSizeGB: int
        name: 'string'
        subnetId: 'string'
        vmSize: 'string'
      }
    ]
  }
}

Property values

openShiftClusters

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties The cluster properties. OpenShiftClusterProperties

OpenShiftClusterProperties

Name Description Value
apiserverProfile The cluster API server profile. APIServerProfile
clusterProfile The cluster profile. ClusterProfile
consoleProfile The console profile. ConsoleProfile
ingressProfiles The cluster ingress profiles. IngressProfile[]
masterProfile The cluster master profile. MasterProfile
networkProfile The cluster network profile. NetworkProfile
provisioningState The cluster provisioning state (immutable). 'AdminUpdating'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'
servicePrincipalProfile The cluster service principal profile. ServicePrincipalProfile
workerProfiles The cluster worker profiles. WorkerProfile[]

APIServerProfile

Name Description Value
ip The IP of the cluster API server (immutable). string
url The URL to access the cluster API server (immutable). string
visibility API server visibility (immutable). 'Private'
'Public'

ClusterProfile

Name Description Value
domain The domain for the cluster (immutable). string
pullSecret The pull secret for the cluster (immutable). string
resourceGroupId The ID of the cluster resource group (immutable). string
version The version of the cluster (immutable). string

ConsoleProfile

Name Description Value
url The URL to access the cluster console (immutable). string

IngressProfile

Name Description Value
ip The IP of the ingress (immutable). string
name The ingress profile name. Must be "default" (immutable). string
visibility Ingress visibility (immutable). 'Private'
'Public'

MasterProfile

Name Description Value
subnetId The Azure resource ID of the master subnet (immutable). string
vmSize The size of the master VMs (immutable). 'Standard_D2s_v3'
'Standard_D4s_v3'
'Standard_D8s_v3'

NetworkProfile

Name Description Value
podCidr The CIDR used for OpenShift/Kubernetes Pods (immutable). string
serviceCidr The CIDR used for OpenShift/Kubernetes Services (immutable). string

ServicePrincipalProfile

Name Description Value
clientId The client ID used for the cluster (immutable). string
clientSecret The client secret used for the cluster (immutable). string

WorkerProfile

Name Description Value
count The number of worker VMs. Must be between 3 and 20 (immutable). int
diskSizeGB The disk size of the worker VMs. Must be 128 or greater (immutable). int
name The worker profile name. Must be "worker" (immutable). string
subnetId The Azure resource ID of the worker subnet (immutable). string
vmSize The size of the worker VMs (immutable). 'Standard_D2s_v3'
'Standard_D4s_v3'
'Standard_D8s_v3'

ARM template resource definition

The openShiftClusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RedHatOpenShift/openShiftClusters resource, add the following JSON to your template.

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2020-04-30",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "apiserverProfile": {
      "ip": "string",
      "url": "string",
      "visibility": "string"
    },
    "clusterProfile": {
      "domain": "string",
      "pullSecret": "string",
      "resourceGroupId": "string",
      "version": "string"
    },
    "consoleProfile": {
      "url": "string"
    },
    "ingressProfiles": [
      {
        "ip": "string",
        "name": "string",
        "visibility": "string"
      }
    ],
    "masterProfile": {
      "subnetId": "string",
      "vmSize": "string"
    },
    "networkProfile": {
      "podCidr": "string",
      "serviceCidr": "string"
    },
    "provisioningState": "string",
    "servicePrincipalProfile": {
      "clientId": "string",
      "clientSecret": "string"
    },
    "workerProfiles": [
      {
        "count": "int",
        "diskSizeGB": "int",
        "name": "string",
        "subnetId": "string",
        "vmSize": "string"
      }
    ]
  }
}

Property values

openShiftClusters

Name Description Value
type The resource type 'Microsoft.RedHatOpenShift/openShiftClusters'
apiVersion The resource api version '2020-04-30'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties The cluster properties. OpenShiftClusterProperties

OpenShiftClusterProperties

Name Description Value
apiserverProfile The cluster API server profile. APIServerProfile
clusterProfile The cluster profile. ClusterProfile
consoleProfile The console profile. ConsoleProfile
ingressProfiles The cluster ingress profiles. IngressProfile[]
masterProfile The cluster master profile. MasterProfile
networkProfile The cluster network profile. NetworkProfile
provisioningState The cluster provisioning state (immutable). 'AdminUpdating'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'
servicePrincipalProfile The cluster service principal profile. ServicePrincipalProfile
workerProfiles The cluster worker profiles. WorkerProfile[]

APIServerProfile

Name Description Value
ip The IP of the cluster API server (immutable). string
url The URL to access the cluster API server (immutable). string
visibility API server visibility (immutable). 'Private'
'Public'

ClusterProfile

Name Description Value
domain The domain for the cluster (immutable). string
pullSecret The pull secret for the cluster (immutable). string
resourceGroupId The ID of the cluster resource group (immutable). string
version The version of the cluster (immutable). string

ConsoleProfile

Name Description Value
url The URL to access the cluster console (immutable). string

IngressProfile

Name Description Value
ip The IP of the ingress (immutable). string
name The ingress profile name. Must be "default" (immutable). string
visibility Ingress visibility (immutable). 'Private'
'Public'

MasterProfile

Name Description Value
subnetId The Azure resource ID of the master subnet (immutable). string
vmSize The size of the master VMs (immutable). 'Standard_D2s_v3'
'Standard_D4s_v3'
'Standard_D8s_v3'

NetworkProfile

Name Description Value
podCidr The CIDR used for OpenShift/Kubernetes Pods (immutable). string
serviceCidr The CIDR used for OpenShift/Kubernetes Services (immutable). string

ServicePrincipalProfile

Name Description Value
clientId The client ID used for the cluster (immutable). string
clientSecret The client secret used for the cluster (immutable). string

WorkerProfile

Name Description Value
count The number of worker VMs. Must be between 3 and 20 (immutable). int
diskSizeGB The disk size of the worker VMs. Must be 128 or greater (immutable). int
name The worker profile name. Must be "worker" (immutable). string
subnetId The Azure resource ID of the worker subnet (immutable). string
vmSize The size of the worker VMs (immutable). 'Standard_D2s_v3'
'Standard_D4s_v3'
'Standard_D8s_v3'

Terraform (AzAPI provider) resource definition

The openShiftClusters resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RedHatOpenShift/openShiftClusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      apiserverProfile = {
        ip = "string"
        url = "string"
        visibility = "string"
      }
      clusterProfile = {
        domain = "string"
        pullSecret = "string"
        resourceGroupId = "string"
        version = "string"
      }
      consoleProfile = {
        url = "string"
      }
      ingressProfiles = [
        {
          ip = "string"
          name = "string"
          visibility = "string"
        }
      ]
      masterProfile = {
        subnetId = "string"
        vmSize = "string"
      }
      networkProfile = {
        podCidr = "string"
        serviceCidr = "string"
      }
      provisioningState = "string"
      servicePrincipalProfile = {
        clientId = "string"
        clientSecret = "string"
      }
      workerProfiles = [
        {
          count = int
          diskSizeGB = int
          name = "string"
          subnetId = "string"
          vmSize = "string"
        }
      ]
    }
  })
}

Property values

openShiftClusters

Name Description Value
type The resource type "Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties The cluster properties. OpenShiftClusterProperties

OpenShiftClusterProperties

Name Description Value
apiserverProfile The cluster API server profile. APIServerProfile
clusterProfile The cluster profile. ClusterProfile
consoleProfile The console profile. ConsoleProfile
ingressProfiles The cluster ingress profiles. IngressProfile[]
masterProfile The cluster master profile. MasterProfile
networkProfile The cluster network profile. NetworkProfile
provisioningState The cluster provisioning state (immutable). "AdminUpdating"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"
servicePrincipalProfile The cluster service principal profile. ServicePrincipalProfile
workerProfiles The cluster worker profiles. WorkerProfile[]

APIServerProfile

Name Description Value
ip The IP of the cluster API server (immutable). string
url The URL to access the cluster API server (immutable). string
visibility API server visibility (immutable). "Private"
"Public"

ClusterProfile

Name Description Value
domain The domain for the cluster (immutable). string
pullSecret The pull secret for the cluster (immutable). string
resourceGroupId The ID of the cluster resource group (immutable). string
version The version of the cluster (immutable). string

ConsoleProfile

Name Description Value
url The URL to access the cluster console (immutable). string

IngressProfile

Name Description Value
ip The IP of the ingress (immutable). string
name The ingress profile name. Must be "default" (immutable). string
visibility Ingress visibility (immutable). "Private"
"Public"

MasterProfile

Name Description Value
subnetId The Azure resource ID of the master subnet (immutable). string
vmSize The size of the master VMs (immutable). "Standard_D2s_v3"
"Standard_D4s_v3"
"Standard_D8s_v3"

NetworkProfile

Name Description Value
podCidr The CIDR used for OpenShift/Kubernetes Pods (immutable). string
serviceCidr The CIDR used for OpenShift/Kubernetes Services (immutable). string

ServicePrincipalProfile

Name Description Value
clientId The client ID used for the cluster (immutable). string
clientSecret The client secret used for the cluster (immutable). string

WorkerProfile

Name Description Value
count The number of worker VMs. Must be between 3 and 20 (immutable). int
diskSizeGB The disk size of the worker VMs. Must be 128 or greater (immutable). int
name The worker profile name. Must be "worker" (immutable). string
subnetId The Azure resource ID of the worker subnet (immutable). string
vmSize The size of the worker VMs (immutable). "Standard_D2s_v3"
"Standard_D4s_v3"
"Standard_D8s_v3"