共用方式為

Microsoft.RedHatOpenShift openShiftClusters 2023-11-22

  • 發行項

Bicep 資源定義

openShiftClusters 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22' = {
  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'
    }
    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'
  }
}

屬性值

APIServerProfile

名字 描述 價值
能見度 API 伺服器可見度。 'Private'
'Public'

ClusterProfile

名字 描述 價值
域 叢集的網域。 字串
fipsValidatedModules 如果使用 FIPS 驗證的加密模組 'Disabled'
'Enabled'
pullSecret 叢集的提取密碼。 字串
resourceGroupId 叢集資源群組的標識碼。 字串
版本 叢集的版本。 字串

ConsoleProfile

名字 描述 價值

IngressProfile

名字 描述 價值
名字 輸入配置檔名稱。 字串
能見度 輸入可見性。 'Private'
'Public'

LoadBalancerProfile

名字 描述 價值
managedOutboundIps 叢集公用負載平衡器所需的受控輸出IP。 ManagedOutboundIPs

ManagedOutboundIPs

名字 描述 價值
計數 計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 int

MasterProfile

名字 描述 價值
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
subnetId 主要子網的 Azure 資源識別碼。 字串
vmSize 主要 VM 的大小。 字串

Microsoft.RedHatOpenShift/openShiftClusters

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 叢集屬性。 OpenShiftClusterProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

NetworkProfile

名字 描述 價值
loadBalancerProfile 叢集負載平衡器配置檔。 LoadBalancerProfile
outboundType 用於輸出流量的 OutboundType。 'Loadbalancer'
'UserDefinedRouting'
podCidr 用於 OpenShift/Kubernetes Pod 的 CIDR。 字串
preconfiguredNSG 指定子網是否使用 NSG 預先連結 'Disabled'
'Enabled'
serviceCidr 用於 OpenShift/Kubernetes Services 的 CIDR。 字串

OpenShiftClusterProperties

名字 描述 價值
apiserverProfile 叢集 API 伺服器設定檔。 APIServerProfile
clusterProfile 叢集配置檔。 ClusterProfile
consoleProfile 主控台配置檔。 ConsoleProfile
ingressProfiles 叢集輸入配置檔。 IngressProfile[]
masterProfile 叢集主要配置檔。 MasterProfile
networkProfile 叢集網路配置檔。 NetworkProfile
provisioningState 叢集布建狀態。 'AdminUpdating'
'Canceled'
'Creating'
'刪除'
'Failed'
'Succeeded'
'Updateing'
servicePrincipalProfile 叢集服務主體配置檔。 ServicePrincipalProfile
workerProfiles 叢集背景工作角色配置檔。 WorkerProfile[]

ServicePrincipalProfile

名字 描述 價值
clientId 用於叢集的用戶端標識碼。 字串
clientSecret 用於叢集的客戶端密碼。 字串

TrackedResourceTags

名字 描述 價值

WorkerProfile

名字 描述 價值
計數 背景工作 VM 的數目。 int
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
diskSizeGB 背景工作 VM 的磁碟大小。 int
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
名字 背景工作角色配置檔名稱。 字串
subnetId 背景工作子網的 Azure 資源識別碼。 字串
vmSize 背景工作 VM 的大小。 字串

ARM 樣本資源定義

openShiftClusters 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2023-11-22",
  "name": "string",
  "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"
    },
    "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"
  }
}

屬性值

APIServerProfile

名字 描述 價值
能見度 API 伺服器可見度。 'Private'
'Public'

ClusterProfile

名字 描述 價值
域 叢集的網域。 字串
fipsValidatedModules 如果使用 FIPS 驗證的加密模組 'Disabled'
'Enabled'
pullSecret 叢集的提取密碼。 字串
resourceGroupId 叢集資源群組的標識碼。 字串
版本 叢集的版本。 字串

ConsoleProfile

名字 描述 價值

IngressProfile

名字 描述 價值
名字 輸入配置檔名稱。 字串
能見度 輸入可見性。 'Private'
'Public'

LoadBalancerProfile

名字 描述 價值
managedOutboundIps 叢集公用負載平衡器所需的受控輸出IP。 ManagedOutboundIPs

ManagedOutboundIPs

名字 描述 價值
計數 計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 int

MasterProfile

名字 描述 價值
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
subnetId 主要子網的 Azure 資源識別碼。 字串
vmSize 主要 VM 的大小。 字串

Microsoft.RedHatOpenShift/openShiftClusters

名字 描述 價值
apiVersion API 版本 '2023-11-22'
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 叢集屬性。 OpenShiftClusterProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.RedHatOpenShift/openShiftClusters'

NetworkProfile

名字 描述 價值
loadBalancerProfile 叢集負載平衡器配置檔。 LoadBalancerProfile
outboundType 用於輸出流量的 OutboundType。 'Loadbalancer'
'UserDefinedRouting'
podCidr 用於 OpenShift/Kubernetes Pod 的 CIDR。 字串
preconfiguredNSG 指定子網是否使用 NSG 預先連結 'Disabled'
'Enabled'
serviceCidr 用於 OpenShift/Kubernetes Services 的 CIDR。 字串

OpenShiftClusterProperties

名字 描述 價值
apiserverProfile 叢集 API 伺服器設定檔。 APIServerProfile
clusterProfile 叢集配置檔。 ClusterProfile
consoleProfile 主控台配置檔。 ConsoleProfile
ingressProfiles 叢集輸入配置檔。 IngressProfile[]
masterProfile 叢集主要配置檔。 MasterProfile
networkProfile 叢集網路配置檔。 NetworkProfile
provisioningState 叢集布建狀態。 'AdminUpdating'
'Canceled'
'Creating'
'刪除'
'Failed'
'Succeeded'
'Updateing'
servicePrincipalProfile 叢集服務主體配置檔。 ServicePrincipalProfile
workerProfiles 叢集背景工作角色配置檔。 WorkerProfile[]

ServicePrincipalProfile

名字 描述 價值
clientId 用於叢集的用戶端標識碼。 字串
clientSecret 用於叢集的客戶端密碼。 字串

TrackedResourceTags

名字 描述 價值

WorkerProfile

名字 描述 價值
計數 背景工作 VM 的數目。 int
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
diskSizeGB 背景工作 VM 的磁碟大小。 int
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
名字 背景工作角色配置檔名稱。 字串
subnetId 背景工作子網的 Azure 資源識別碼。 字串
vmSize 背景工作 VM 的大小。 字串

Terraform （AzAPI 提供者） 資源定義

openShiftClusters 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.RedHatOpenShift/openShiftClusters 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
      }
      provisioningState = "string"
      servicePrincipalProfile = {
        clientId = "string"
        clientSecret = "string"
      }
      workerProfiles = [
        {
          count = int
          diskEncryptionSetId = "string"
          diskSizeGB = int
          encryptionAtHost = "string"
          name = "string"
          subnetId = "string"
          vmSize = "string"
        }
      ]
    }
  })
}

屬性值

APIServerProfile

名字 描述 價值
能見度 API 伺服器可見度。 'Private'
'Public'

ClusterProfile

名字 描述 價值
域 叢集的網域。 字串
fipsValidatedModules 如果使用 FIPS 驗證的加密模組 'Disabled'
'Enabled'
pullSecret 叢集的提取密碼。 字串
resourceGroupId 叢集資源群組的標識碼。 字串
版本 叢集的版本。 字串

ConsoleProfile

名字 描述 價值

IngressProfile

名字 描述 價值
名字 輸入配置檔名稱。 字串
能見度 輸入可見性。 'Private'
'Public'

LoadBalancerProfile

名字 描述 價值
managedOutboundIps 叢集公用負載平衡器所需的受控輸出IP。 ManagedOutboundIPs

ManagedOutboundIPs

名字 描述 價值
計數 計數代表由 Azure 為叢集公用負載平衡器建立及管理的所需 IPv4 輸出 IP 數目。 允許的值介於 1 - 20 的範圍內。 預設值為 1。 int

MasterProfile

名字 描述 價值
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
subnetId 主要子網的 Azure 資源識別碼。 字串
vmSize 主要 VM 的大小。 字串

Microsoft.RedHatOpenShift/openShiftClusters

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 叢集屬性。 OpenShiftClusterProperties
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22”

NetworkProfile

名字 描述 價值
loadBalancerProfile 叢集負載平衡器配置檔。 LoadBalancerProfile
outboundType 用於輸出流量的 OutboundType。 'Loadbalancer'
'UserDefinedRouting'
podCidr 用於 OpenShift/Kubernetes Pod 的 CIDR。 字串
preconfiguredNSG 指定子網是否使用 NSG 預先連結 'Disabled'
'Enabled'
serviceCidr 用於 OpenShift/Kubernetes Services 的 CIDR。 字串

OpenShiftClusterProperties

名字 描述 價值
apiserverProfile 叢集 API 伺服器設定檔。 APIServerProfile
clusterProfile 叢集配置檔。 ClusterProfile
consoleProfile 主控台配置檔。 ConsoleProfile
ingressProfiles 叢集輸入配置檔。 IngressProfile[]
masterProfile 叢集主要配置檔。 MasterProfile
networkProfile 叢集網路配置檔。 NetworkProfile
provisioningState 叢集布建狀態。 'AdminUpdating'
'Canceled'
'Creating'
'刪除'
'Failed'
'Succeeded'
'Updateing'
servicePrincipalProfile 叢集服務主體配置檔。 ServicePrincipalProfile
workerProfiles 叢集背景工作角色配置檔。 WorkerProfile[]

ServicePrincipalProfile

名字 描述 價值
clientId 用於叢集的用戶端標識碼。 字串
clientSecret 用於叢集的客戶端密碼。 字串

TrackedResourceTags

名字 描述 價值

WorkerProfile

名字 描述 價值
計數 背景工作 VM 的數目。 int
diskEncryptionSetId 如果適用，則為相關聯的 DiskEncryptionSet 的資源標識符。 字串
diskSizeGB 背景工作 VM 的磁碟大小。 int
encryptionAtHost 主要虛擬機是否在主機上加密。 'Disabled'
'Enabled'
名字 背景工作角色配置檔名稱。 字串
subnetId 背景工作子網的 Azure 資源識別碼。 字串
vmSize 背景工作 VM 的大小。 字串