Bicep 資源定義
openShiftClusters 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2025-07-25' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
apiserverProfile: {
visibility: 'string'
}
clusterProfile: {
domain: 'string'
fipsValidatedModules: 'string'
pullSecret: 'string'
resourceGroupId: 'string'
version: 'string'
}
consoleProfile: {}
ingressProfiles: [
{
name: 'string'
visibility: 'string'
}
]
masterProfile: {
diskEncryptionSetId: 'string'
encryptionAtHost: 'string'
subnetId: 'string'
vmSize: 'string'
}
networkProfile: {
loadBalancerProfile: {
managedOutboundIps: {
count: int
}
}
outboundType: 'string'
podCidr: 'string'
preconfiguredNSG: 'string'
serviceCidr: 'string'
}
platformWorkloadIdentityProfile: {
platformWorkloadIdentities: {
{customized property}: {
resourceId: 'string'
}
}
upgradeableTo: 'string'
}
provisioningState: 'string'
servicePrincipalProfile: {
clientId: 'string'
clientSecret: 'string'
}
workerProfiles: [
{
count: int
diskEncryptionSetId: 'string'
diskSizeGB: int
encryptionAtHost: 'string'
name: 'string'
subnetId: 'string'
vmSize: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
屬性值
Microsoft.RedHatOpenShift/openShiftClusters
APIServerProfile
| 名字 |
描述 |
價值 |
| 能見度 |
API 伺服器可見度。 |
“私人” '公開' |
集群配置檔
| 名字 |
描述 |
價值 |
| 網域 |
叢集的網域。 |
字串 |
| fipsValidatedModules 模組 |
如果使用 FIPS 驗證的加密模組 |
“已禁用” “已啟用” |
| pullSecret |
叢集的提取密碼。 |
字串 |
| 資源群組識別碼 (resourceGroupId) |
叢集資源群組的標識碼。 |
字串 |
| 版本 |
叢集的版本。 |
字串 |
ConsoleProfile
入口配置檔
| 名字 |
描述 |
價值 |
| 名字 |
輸入配置檔名稱。 |
字串 |
| 能見度 |
輸入可見性。 |
“私人” '公開' |
LoadBalancer配置檔
ManagedOutboundIP
| 名字 |
描述 |
價值 |
| 計數 |
計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 |
整數 (int) |
ManagedServiceIdentity
| 名字 |
描述 |
價值 |
| 型別 |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
“無” “系統分配” 'SystemAssigned,UserAssigned' 'UserAssigned' (必要) |
| 使用者指派的身份 |
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。 |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MasterProfile
| 名字 |
描述 |
價值 |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 子網ID |
主要子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
主要 VM 的大小。 |
字串 |
網路簡介
| 名字 |
描述 |
價值 |
| loadBalancer配置檔 |
叢集負載平衡器配置檔。 |
LoadBalancer配置檔 |
| outbound類型 |
用於輸出流量的 OutboundType。 |
“負載均衡器” 'UserDefinedRouting' (使用者定義路由) |
| podCidr |
用於 OpenShift/Kubernetes Pod 的 CIDR。 |
字串 |
| 預配置 NSG |
指定子網是否使用 NSG 預先連結 |
“已禁用” “已啟用” |
| 服務CIDR |
用於 OpenShift/Kubernetes Services 的 CIDR。 |
字串 |
OpenShiftClusterProperties
| 名字 |
描述 |
價值 |
| 資源ID |
PlatformWorkloadIdentity 資源的資源標識符 |
字串 |
ServicePrincipalProfile
| 名字 |
描述 |
價值 |
| 用戶端ID |
用於叢集的用戶端標識碼。 |
字串 |
| 用戶端密鑰 |
用於叢集的客戶端密碼。 |
字串 |
UserAssignedIdentity
工人檔案
| 名字 |
描述 |
價值 |
| 計數 |
背景工作 VM 的數目。 |
整數 (int) |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| diskSizeGB 磁碟大小 |
背景工作 VM 的磁碟大小。 |
整數 (int) |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 名字 |
背景工作角色配置檔名稱。 |
字串 |
| 子網ID |
背景工作子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
背景工作 VM 的大小。 |
字串 |
ARM 樣本資源定義
openShiftClusters 資源類型可以使用目標作業來部署:
使用範例
若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.RedHatOpenShift/openShiftClusters",
"apiVersion": "2025-07-25",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"apiserverProfile": {
"visibility": "string"
},
"clusterProfile": {
"domain": "string",
"fipsValidatedModules": "string",
"pullSecret": "string",
"resourceGroupId": "string",
"version": "string"
},
"consoleProfile": {
},
"ingressProfiles": [
{
"name": "string",
"visibility": "string"
}
],
"masterProfile": {
"diskEncryptionSetId": "string",
"encryptionAtHost": "string",
"subnetId": "string",
"vmSize": "string"
},
"networkProfile": {
"loadBalancerProfile": {
"managedOutboundIps": {
"count": "int"
}
},
"outboundType": "string",
"podCidr": "string",
"preconfiguredNSG": "string",
"serviceCidr": "string"
},
"platformWorkloadIdentityProfile": {
"platformWorkloadIdentities": {
"{customized property}": {
"resourceId": "string"
}
},
"upgradeableTo": "string"
},
"provisioningState": "string",
"servicePrincipalProfile": {
"clientId": "string",
"clientSecret": "string"
},
"workerProfiles": [
{
"count": "int",
"diskEncryptionSetId": "string",
"diskSizeGB": "int",
"encryptionAtHost": "string",
"name": "string",
"subnetId": "string",
"vmSize": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
屬性值
Microsoft.RedHatOpenShift/openShiftClusters
APIServerProfile
| 名字 |
描述 |
價值 |
| 能見度 |
API 伺服器可見度。 |
“私人” '公開' |
集群配置檔
| 名字 |
描述 |
價值 |
| 網域 |
叢集的網域。 |
字串 |
| fipsValidatedModules 模組 |
如果使用 FIPS 驗證的加密模組 |
“已禁用” “已啟用” |
| pullSecret |
叢集的提取密碼。 |
字串 |
| 資源群組識別碼 (resourceGroupId) |
叢集資源群組的標識碼。 |
字串 |
| 版本 |
叢集的版本。 |
字串 |
ConsoleProfile
入口配置檔
| 名字 |
描述 |
價值 |
| 名字 |
輸入配置檔名稱。 |
字串 |
| 能見度 |
輸入可見性。 |
“私人” '公開' |
LoadBalancer配置檔
ManagedOutboundIP
| 名字 |
描述 |
價值 |
| 計數 |
計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 |
整數 (int) |
ManagedServiceIdentity
| 名字 |
描述 |
價值 |
| 型別 |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
“無” “系統分配” 'SystemAssigned,UserAssigned' 'UserAssigned' (必要) |
| 使用者指派的身份 |
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。 |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MasterProfile
| 名字 |
描述 |
價值 |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 子網ID |
主要子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
主要 VM 的大小。 |
字串 |
網路簡介
| 名字 |
描述 |
價值 |
| loadBalancer配置檔 |
叢集負載平衡器配置檔。 |
LoadBalancer配置檔 |
| outbound類型 |
用於輸出流量的 OutboundType。 |
“負載均衡器” 'UserDefinedRouting' (使用者定義路由) |
| podCidr |
用於 OpenShift/Kubernetes Pod 的 CIDR。 |
字串 |
| 預配置 NSG |
指定子網是否使用 NSG 預先連結 |
“已禁用” “已啟用” |
| 服務CIDR |
用於 OpenShift/Kubernetes Services 的 CIDR。 |
字串 |
OpenShiftClusterProperties
| 名字 |
描述 |
價值 |
| 資源ID |
PlatformWorkloadIdentity 資源的資源標識符 |
字串 |
ServicePrincipalProfile
| 名字 |
描述 |
價值 |
| 用戶端ID |
用於叢集的用戶端標識碼。 |
字串 |
| 用戶端密鑰 |
用於叢集的客戶端密碼。 |
字串 |
UserAssignedIdentity
工人檔案
| 名字 |
描述 |
價值 |
| 計數 |
背景工作 VM 的數目。 |
整數 (int) |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| diskSizeGB 磁碟大小 |
背景工作 VM 的磁碟大小。 |
整數 (int) |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 名字 |
背景工作角色配置檔名稱。 |
字串 |
| 子網ID |
背景工作子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
背景工作 VM 的大小。 |
字串 |
openShiftClusters 資源類型可以使用目標作業來部署:
-
資源團體 關於每個 API 版本變更屬性的清單,請參見 變更日誌。
使用範例
Azure 已驗證的模組
下列 Azure 驗證模組 可用來部署此資源類型。
若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/openShiftClusters@2025-07-25"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
apiserverProfile = {
visibility = "string"
}
clusterProfile = {
domain = "string"
fipsValidatedModules = "string"
pullSecret = "string"
resourceGroupId = "string"
version = "string"
}
consoleProfile = {
}
ingressProfiles = [
{
name = "string"
visibility = "string"
}
]
masterProfile = {
diskEncryptionSetId = "string"
encryptionAtHost = "string"
subnetId = "string"
vmSize = "string"
}
networkProfile = {
loadBalancerProfile = {
managedOutboundIps = {
count = int
}
}
outboundType = "string"
podCidr = "string"
preconfiguredNSG = "string"
serviceCidr = "string"
}
platformWorkloadIdentityProfile = {
platformWorkloadIdentities = {
{customized property} = {
resourceId = "string"
}
}
upgradeableTo = "string"
}
provisioningState = "string"
servicePrincipalProfile = {
clientId = "string"
clientSecret = "string"
}
workerProfiles = [
{
count = int
diskEncryptionSetId = "string"
diskSizeGB = int
encryptionAtHost = "string"
name = "string"
subnetId = "string"
vmSize = "string"
}
]
}
}
}
屬性值
Microsoft.RedHatOpenShift/openShiftClusters
APIServerProfile
| 名字 |
描述 |
價值 |
| 能見度 |
API 伺服器可見度。 |
“私人” '公開' |
集群配置檔
| 名字 |
描述 |
價值 |
| 網域 |
叢集的網域。 |
字串 |
| fipsValidatedModules 模組 |
如果使用 FIPS 驗證的加密模組 |
“已禁用” “已啟用” |
| pullSecret |
叢集的提取密碼。 |
字串 |
| 資源群組識別碼 (resourceGroupId) |
叢集資源群組的標識碼。 |
字串 |
| 版本 |
叢集的版本。 |
字串 |
ConsoleProfile
入口配置檔
| 名字 |
描述 |
價值 |
| 名字 |
輸入配置檔名稱。 |
字串 |
| 能見度 |
輸入可見性。 |
“私人” '公開' |
LoadBalancer配置檔
ManagedOutboundIP
| 名字 |
描述 |
價值 |
| 計數 |
計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 |
整數 (int) |
ManagedServiceIdentity
| 名字 |
描述 |
價值 |
| 型別 |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
“無” “系統分配” 'SystemAssigned,UserAssigned' 'UserAssigned' (必要) |
| 使用者指派的身份 |
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。 |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
MasterProfile
| 名字 |
描述 |
價值 |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 子網ID |
主要子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
主要 VM 的大小。 |
字串 |
網路簡介
| 名字 |
描述 |
價值 |
| loadBalancer配置檔 |
叢集負載平衡器配置檔。 |
LoadBalancer配置檔 |
| outbound類型 |
用於輸出流量的 OutboundType。 |
“負載均衡器” 'UserDefinedRouting' (使用者定義路由) |
| podCidr |
用於 OpenShift/Kubernetes Pod 的 CIDR。 |
字串 |
| 預配置 NSG |
指定子網是否使用 NSG 預先連結 |
“已禁用” “已啟用” |
| 服務CIDR |
用於 OpenShift/Kubernetes Services 的 CIDR。 |
字串 |
OpenShiftClusterProperties
| 名字 |
描述 |
價值 |
| 資源ID |
PlatformWorkloadIdentity 資源的資源標識符 |
字串 |
ServicePrincipalProfile
| 名字 |
描述 |
價值 |
| 用戶端ID |
用於叢集的用戶端標識碼。 |
字串 |
| 用戶端密鑰 |
用於叢集的客戶端密碼。 |
字串 |
UserAssignedIdentity
工人檔案
| 名字 |
描述 |
價值 |
| 計數 |
背景工作 VM 的數目。 |
整數 (int) |
| diskEncryptionSetId |
如果適用,則為相關聯的 DiskEncryptionSet 的資源標識符。 |
字串 |
| diskSizeGB 磁碟大小 |
背景工作 VM 的磁碟大小。 |
整數 (int) |
| encryptionAtHost |
主要虛擬機是否在主機上加密。 |
“已禁用” “已啟用” |
| 名字 |
背景工作角色配置檔名稱。 |
字串 |
| 子網ID |
背景工作子網的 Azure 資源識別碼。 |
字串 |
| vmSize |
背景工作 VM 的大小。 |
字串 |