Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The openShiftManagedClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerService/openShiftManagedClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerService/openShiftManagedClusters@2019-10-27-preview' = {
location: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
}
properties: {
agentPoolProfiles: [
{
count: int
name: 'string'
osType: 'string'
role: 'string'
subnetCidr: 'string'
vmSize: 'string'
}
]
authProfile: {
identityProviders: [
{
name: 'string'
provider: {
kind: 'string'
// For remaining properties, see OpenShiftManagedClusterBaseIdentityProvider objects
}
}
]
}
masterPoolProfile: {
apiProperties: {
privateApiServer: bool
}
count: int
subnetCidr: 'string'
vmSize: 'string'
}
monitorProfile: {
enabled: bool
workspaceResourceID: 'string'
}
networkProfile: {
managementSubnetCidr: 'string'
vnetCidr: 'string'
vnetId: 'string'
}
openShiftVersion: 'string'
refreshCluster: bool
routerProfiles: [
{
name: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
OpenShiftManagedClusterBaseIdentityProvider objects
Set the kind property to specify the type of object.
For AADIdentityProvider, use:
{
clientId: 'string'
customerAdminGroupId: 'string'
kind: 'AADIdentityProvider'
secret: 'string'
tenantId: 'string'
}
Property Values
Microsoft.ContainerService/openShiftManagedClusters
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| plan | Define the resource plan as required by ARM for billing purposes | PurchasePlan |
| properties | Properties of a OpenShift managed cluster. | OpenShiftManagedClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| managementSubnetCidr | CIDR of subnet used to create PLS needed for management of the cluster | string |
| vnetCidr | CIDR for the OpenShift Vnet. | string |
| vnetId | ID of the Vnet created for OSA cluster. | string |
OpenShiftAPIProperties
| Name | Description | Value |
|---|---|---|
| privateApiServer | Specifies if API server is public or private. | bool |
OpenShiftManagedClusterAADIdentityProvider
| Name | Description | Value |
|---|---|---|
| clientId | The clientId password associated with the provider. | string |
| customerAdminGroupId | The groupId to be granted cluster admin role. | string |
| kind | The kind of the provider. | 'AADIdentityProvider' (required) |
| secret | The secret password associated with the provider. | string |
| tenantId | The tenantId associated with the provider. | string |
OpenShiftManagedClusterAgentPoolProfile
| Name | Description | Value |
|---|---|---|
| count | Number of agents (VMs) to host docker containers. | int (required) |
| name | Unique name of the pool profile in the context of the subscription and resource group. | string (required) |
| osType | OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. | 'Linux' 'Windows' |
| role | Define the role of the AgentPoolProfile. | 'compute' 'infra' |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterAuthProfile
| Name | Description | Value |
|---|---|---|
| identityProviders | Type of authentication profile to use. | OpenShiftManagedClusterIdentityProvider[] |
OpenShiftManagedClusterBaseIdentityProvider
| Name | Description | Value |
|---|---|---|
| kind | Set to 'AADIdentityProvider' for type OpenShiftManagedClusterAADIdentityProvider. | 'AADIdentityProvider' (required) |
OpenShiftManagedClusterIdentityProvider
| Name | Description | Value |
|---|---|---|
| name | Name of the provider. | string |
| provider | Configuration of the provider. | OpenShiftManagedClusterBaseIdentityProvider |
OpenShiftManagedClusterMasterPoolProfile
| Name | Description | Value |
|---|---|---|
| apiProperties | Defines further properties on the API. | OpenShiftAPIProperties |
| count | Number of masters (VMs) to host docker containers. The default value is 3. | int (required) |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterMonitorProfile
| Name | Description | Value |
|---|---|---|
| enabled | If the Log analytics integration should be turned on or off | bool |
| workspaceResourceID | Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with. | string |
OpenShiftManagedClusterProperties
| Name | Description | Value |
|---|---|---|
| agentPoolProfiles | Configuration of OpenShift cluster VMs. | OpenShiftManagedClusterAgentPoolProfile[] |
| authProfile | Configures OpenShift authentication. | OpenShiftManagedClusterAuthProfile |
| masterPoolProfile | Configuration for OpenShift master VMs. | OpenShiftManagedClusterMasterPoolProfile |
| monitorProfile | Configures Log Analytics integration. | OpenShiftManagedClusterMonitorProfile |
| networkProfile | Configuration for OpenShift networking. | NetworkProfile |
| openShiftVersion | Version of OpenShift specified when creating the cluster. | string (required) |
| refreshCluster | Allows node rotation | bool |
| routerProfiles | Configuration for OpenShift router(s). | OpenShiftRouterProfile[] |
OpenShiftRouterProfile
| Name | Description | Value |
|---|---|---|
| name | Name of the router profile. | string |
PurchasePlan
| Name | Description | Value |
|---|---|---|
| name | The plan ID. | string |
| product | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | string |
| promotionCode | The promotion code. | string |
| publisher | The plan ID. | string |
ResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The openShiftManagedClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerService/openShiftManagedClusters resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerService/openShiftManagedClusters",
"apiVersion": "2019-10-27-preview",
"name": "string",
"location": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string"
},
"properties": {
"agentPoolProfiles": [
{
"count": "int",
"name": "string",
"osType": "string",
"role": "string",
"subnetCidr": "string",
"vmSize": "string"
}
],
"authProfile": {
"identityProviders": [
{
"name": "string",
"provider": {
"kind": "string"
// For remaining properties, see OpenShiftManagedClusterBaseIdentityProvider objects
}
}
]
},
"masterPoolProfile": {
"apiProperties": {
"privateApiServer": "bool"
},
"count": "int",
"subnetCidr": "string",
"vmSize": "string"
},
"monitorProfile": {
"enabled": "bool",
"workspaceResourceID": "string"
},
"networkProfile": {
"managementSubnetCidr": "string",
"vnetCidr": "string",
"vnetId": "string"
},
"openShiftVersion": "string",
"refreshCluster": "bool",
"routerProfiles": [
{
"name": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
OpenShiftManagedClusterBaseIdentityProvider objects
Set the kind property to specify the type of object.
For AADIdentityProvider, use:
{
"clientId": "string",
"customerAdminGroupId": "string",
"kind": "AADIdentityProvider",
"secret": "string",
"tenantId": "string"
}
Property Values
Microsoft.ContainerService/openShiftManagedClusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-10-27-preview' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| plan | Define the resource plan as required by ARM for billing purposes | PurchasePlan |
| properties | Properties of a OpenShift managed cluster. | OpenShiftManagedClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ContainerService/openShiftManagedClusters' |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| managementSubnetCidr | CIDR of subnet used to create PLS needed for management of the cluster | string |
| vnetCidr | CIDR for the OpenShift Vnet. | string |
| vnetId | ID of the Vnet created for OSA cluster. | string |
OpenShiftAPIProperties
| Name | Description | Value |
|---|---|---|
| privateApiServer | Specifies if API server is public or private. | bool |
OpenShiftManagedClusterAADIdentityProvider
| Name | Description | Value |
|---|---|---|
| clientId | The clientId password associated with the provider. | string |
| customerAdminGroupId | The groupId to be granted cluster admin role. | string |
| kind | The kind of the provider. | 'AADIdentityProvider' (required) |
| secret | The secret password associated with the provider. | string |
| tenantId | The tenantId associated with the provider. | string |
OpenShiftManagedClusterAgentPoolProfile
| Name | Description | Value |
|---|---|---|
| count | Number of agents (VMs) to host docker containers. | int (required) |
| name | Unique name of the pool profile in the context of the subscription and resource group. | string (required) |
| osType | OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. | 'Linux' 'Windows' |
| role | Define the role of the AgentPoolProfile. | 'compute' 'infra' |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterAuthProfile
| Name | Description | Value |
|---|---|---|
| identityProviders | Type of authentication profile to use. | OpenShiftManagedClusterIdentityProvider[] |
OpenShiftManagedClusterBaseIdentityProvider
| Name | Description | Value |
|---|---|---|
| kind | Set to 'AADIdentityProvider' for type OpenShiftManagedClusterAADIdentityProvider. | 'AADIdentityProvider' (required) |
OpenShiftManagedClusterIdentityProvider
| Name | Description | Value |
|---|---|---|
| name | Name of the provider. | string |
| provider | Configuration of the provider. | OpenShiftManagedClusterBaseIdentityProvider |
OpenShiftManagedClusterMasterPoolProfile
| Name | Description | Value |
|---|---|---|
| apiProperties | Defines further properties on the API. | OpenShiftAPIProperties |
| count | Number of masters (VMs) to host docker containers. The default value is 3. | int (required) |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterMonitorProfile
| Name | Description | Value |
|---|---|---|
| enabled | If the Log analytics integration should be turned on or off | bool |
| workspaceResourceID | Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with. | string |
OpenShiftManagedClusterProperties
| Name | Description | Value |
|---|---|---|
| agentPoolProfiles | Configuration of OpenShift cluster VMs. | OpenShiftManagedClusterAgentPoolProfile[] |
| authProfile | Configures OpenShift authentication. | OpenShiftManagedClusterAuthProfile |
| masterPoolProfile | Configuration for OpenShift master VMs. | OpenShiftManagedClusterMasterPoolProfile |
| monitorProfile | Configures Log Analytics integration. | OpenShiftManagedClusterMonitorProfile |
| networkProfile | Configuration for OpenShift networking. | NetworkProfile |
| openShiftVersion | Version of OpenShift specified when creating the cluster. | string (required) |
| refreshCluster | Allows node rotation | bool |
| routerProfiles | Configuration for OpenShift router(s). | OpenShiftRouterProfile[] |
OpenShiftRouterProfile
| Name | Description | Value |
|---|---|---|
| name | Name of the router profile. | string |
PurchasePlan
| Name | Description | Value |
|---|---|---|
| name | The plan ID. | string |
| product | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | string |
| promotionCode | The promotion code. | string |
| publisher | The plan ID. | string |
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The openShiftManagedClusters 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.ContainerService/openShiftManagedClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerService/openShiftManagedClusters@2019-10-27-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
}
properties = {
agentPoolProfiles = [
{
count = int
name = "string"
osType = "string"
role = "string"
subnetCidr = "string"
vmSize = "string"
}
]
authProfile = {
identityProviders = [
{
name = "string"
provider = {
kind = "string"
// For remaining properties, see OpenShiftManagedClusterBaseIdentityProvider objects
}
}
]
}
masterPoolProfile = {
apiProperties = {
privateApiServer = bool
}
count = int
subnetCidr = "string"
vmSize = "string"
}
monitorProfile = {
enabled = bool
workspaceResourceID = "string"
}
networkProfile = {
managementSubnetCidr = "string"
vnetCidr = "string"
vnetId = "string"
}
openShiftVersion = "string"
refreshCluster = bool
routerProfiles = [
{
name = "string"
}
]
}
}
}
OpenShiftManagedClusterBaseIdentityProvider objects
Set the kind property to specify the type of object.
For AADIdentityProvider, use:
{
clientId = "string"
customerAdminGroupId = "string"
kind = "AADIdentityProvider"
secret = "string"
tenantId = "string"
}
Property Values
Microsoft.ContainerService/openShiftManagedClusters
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| plan | Define the resource plan as required by ARM for billing purposes | PurchasePlan |
| properties | Properties of a OpenShift managed cluster. | OpenShiftManagedClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ContainerService/openShiftManagedClusters@2019-10-27-preview" |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| managementSubnetCidr | CIDR of subnet used to create PLS needed for management of the cluster | string |
| vnetCidr | CIDR for the OpenShift Vnet. | string |
| vnetId | ID of the Vnet created for OSA cluster. | string |
OpenShiftAPIProperties
| Name | Description | Value |
|---|---|---|
| privateApiServer | Specifies if API server is public or private. | bool |
OpenShiftManagedClusterAADIdentityProvider
| Name | Description | Value |
|---|---|---|
| clientId | The clientId password associated with the provider. | string |
| customerAdminGroupId | The groupId to be granted cluster admin role. | string |
| kind | The kind of the provider. | 'AADIdentityProvider' (required) |
| secret | The secret password associated with the provider. | string |
| tenantId | The tenantId associated with the provider. | string |
OpenShiftManagedClusterAgentPoolProfile
| Name | Description | Value |
|---|---|---|
| count | Number of agents (VMs) to host docker containers. | int (required) |
| name | Unique name of the pool profile in the context of the subscription and resource group. | string (required) |
| osType | OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. | 'Linux' 'Windows' |
| role | Define the role of the AgentPoolProfile. | 'compute' 'infra' |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterAuthProfile
| Name | Description | Value |
|---|---|---|
| identityProviders | Type of authentication profile to use. | OpenShiftManagedClusterIdentityProvider[] |
OpenShiftManagedClusterBaseIdentityProvider
| Name | Description | Value |
|---|---|---|
| kind | Set to 'AADIdentityProvider' for type OpenShiftManagedClusterAADIdentityProvider. | 'AADIdentityProvider' (required) |
OpenShiftManagedClusterIdentityProvider
| Name | Description | Value |
|---|---|---|
| name | Name of the provider. | string |
| provider | Configuration of the provider. | OpenShiftManagedClusterBaseIdentityProvider |
OpenShiftManagedClusterMasterPoolProfile
| Name | Description | Value |
|---|---|---|
| apiProperties | Defines further properties on the API. | OpenShiftAPIProperties |
| count | Number of masters (VMs) to host docker containers. The default value is 3. | int (required) |
| subnetCidr | Subnet CIDR for the peering. | string |
| vmSize | Size of agent VMs. | 'Standard_D16s_v3' 'Standard_D2s_v3' 'Standard_D32s_v3' 'Standard_D4s_v3' 'Standard_D64s_v3' 'Standard_D8s_v3' 'Standard_DS12_v2' 'Standard_DS13_v2' 'Standard_DS14_v2' 'Standard_DS15_v2' 'Standard_DS4_v2' 'Standard_DS5_v2' 'Standard_E16s_v3' 'Standard_E20s_v3' 'Standard_E32s_v3' 'Standard_E4s_v3' 'Standard_E64s_v3' 'Standard_E8s_v3' 'Standard_F16s' 'Standard_F16s_v2' 'Standard_F32s_v2' 'Standard_F64s_v2' 'Standard_F72s_v2' 'Standard_F8s' 'Standard_F8s_v2' 'Standard_GS2' 'Standard_GS3' 'Standard_GS4' 'Standard_GS5' 'Standard_L16s' 'Standard_L32s' 'Standard_L4s' 'Standard_L8s' (required) |
OpenShiftManagedClusterMonitorProfile
| Name | Description | Value |
|---|---|---|
| enabled | If the Log analytics integration should be turned on or off | bool |
| workspaceResourceID | Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with. | string |
OpenShiftManagedClusterProperties
| Name | Description | Value |
|---|---|---|
| agentPoolProfiles | Configuration of OpenShift cluster VMs. | OpenShiftManagedClusterAgentPoolProfile[] |
| authProfile | Configures OpenShift authentication. | OpenShiftManagedClusterAuthProfile |
| masterPoolProfile | Configuration for OpenShift master VMs. | OpenShiftManagedClusterMasterPoolProfile |
| monitorProfile | Configures Log Analytics integration. | OpenShiftManagedClusterMonitorProfile |
| networkProfile | Configuration for OpenShift networking. | NetworkProfile |
| openShiftVersion | Version of OpenShift specified when creating the cluster. | string (required) |
| refreshCluster | Allows node rotation | bool |
| routerProfiles | Configuration for OpenShift router(s). | OpenShiftRouterProfile[] |
OpenShiftRouterProfile
| Name | Description | Value |
|---|---|---|
| name | Name of the router profile. | string |
PurchasePlan
| Name | Description | Value |
|---|---|---|
| name | The plan ID. | string |
| product | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | string |
| promotionCode | The promotion code. | string |
| publisher | The plan ID. | string |
ResourceTags
| Name | Description | Value |
|---|