你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.RedHatOpenShift openShift集群

Bicep 资源定义

可以使用目标操作部署 openShiftClusters 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2024-08-12-preview' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    apiserverProfile: {
      visibility: 'string'
    }
    clusterProfile: {
      domain: 'string'
      fipsValidatedModules: 'string'
      oidcIssuer: '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

名字 描述 价值
标识 标识将有关群集 MSI 的信息存储在工作负荷标识群集中。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
性能 群集属性。 OpenShiftClusterProperties
作用域 在与部署范围不同的范围内创建资源时使用。 将此属性设置为资源的符号名称以应用 扩展资源
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

APIServerProfile

名字 描述 价值
能见度 API 服务器可见性。 “Private”
“Public”

集群配置文件

名字 描述 价值
群集的域。 字符串
fipsValidatedModules 模块 如果使用 FIPS 验证的加密模块 “Disabled”
“Enabled”
oidc颁发者 工作负荷标识群集中托管 OIDC 颁发者的 URL。 字符串
pullSecret 群集的拉取机密。 字符串
资源组ID 群集资源组的 ID。 字符串
版本 群集的版本。 字符串

ConsoleProfile

名字 描述 价值

入口配置文件

名字 描述 价值
名字 入口配置文件名称。 字符串
能见度 入口可见性。 “Private”
“Public”

LoadBalancer配置文件

名字 描述 价值
managedOutboundIps 群集公共负载均衡器的所需托管出站 IP。 ManagedOutboundIP

ManagedOutboundIP

名字 描述 价值
计数 计数表示 Azure 为群集公共负载均衡器创建和管理的所需 IPv4 出站 IP 数。 允许的值为 1 - 20。 默认值为 1。 整数 (int)

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

MasterProfile

名字 描述 价值
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
子网 ID 主子网的 Azure 资源 ID。 字符串
vmSize 主 VM 的大小。 字符串

网络简介

名字 描述 价值
loadBalancer配置文件 群集负载均衡器配置文件。 LoadBalancer配置文件
outbound类型 用于出口流量的 OutboundType。 “Loadbalancer”
“UserDefinedRouting”
podCidr 用于 OpenShift/Kubernetes Pod 的 CIDR。 字符串
预配置 NSG 指定是否使用 NSG 预附加子网 “Disabled”
“Enabled”
serviceCidr 服务 用于 OpenShift/Kubernetes 服务的 CIDR。 字符串

OpenShiftClusterProperties

名字 描述 价值
apiserver简介 群集 API 服务器配置文件。 APIServerProfile
clusterProfile 群集配置文件。 集群配置文件
console配置文件 控制台配置文件。 ConsoleProfile
ingressProfiles (入口配置文件) 群集入口配置文件。 IngressProfile[]
masterProfile 群集主配置文件。 MasterProfile
网络简介 群集网络配置文件。 网络简介
platformWorkloadIdentity配置文件 工作负荷标识配置文件。 PlatformWorkloadIdentityProfile
provisioningState 群集预配状态。 “AdminUpdating”
“Canceled”
“创建”
“删除”
“Failed”
“Succeeded”
“正在更新”
servicePrincipal简介 群集服务主体配置文件。 ServicePrincipalProfile
worker配置文件 群集辅助角色配置文件。 工人档案

PlatformWorkloadIdentity

名字 描述 价值
资源ID PlatformWorkloadIdentity 资源的资源 ID 字符串

PlatformWorkloadIdentityProfile

名字 描述 价值
platformWorkloadIdentities platformWorkloadIdentity<>字典 PlatformWorkloadIdentityProfilePlatformWorkloadIdentities
upgradeableTo UpgradeableTo 存储一个 OpenShift 版本,工作负荷标识群集可以升级到 字符串

PlatformWorkloadIdentityProfilePlatformWorkloadIdentities

名字 描述 价值

ServicePrincipalProfile

名字 描述 价值
客户端 ID 用于群集的客户端 ID。 字符串
客户密钥 用于群集的客户端密码。 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

工人档案

名字 描述 价值
计数 辅助角色 VM 的数量。 整数 (int)
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
diskSizeGB 磁盘大小 辅助角色 VM 的磁盘大小。 整数 (int)
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
名字 辅助角色配置文件名称。 字符串
子网 ID 辅助角色子网的 Azure 资源 ID。 字符串
vmSize 辅助角色 VM 的大小。 字符串

ARM 模板资源定义

可以使用目标操作部署 openShiftClusters 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2024-08-12-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "apiserverProfile": {
      "visibility": "string"
    },
    "clusterProfile": {
      "domain": "string",
      "fipsValidatedModules": "string",
      "oidcIssuer": "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

名字 描述 价值
apiVersion API 版本 “2024-08-12-预览”
标识 标识将有关群集 MSI 的信息存储在工作负荷标识群集中。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
性能 群集属性。 OpenShiftClusterProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.RedHatOpenShift/openShiftClusters”

APIServerProfile

名字 描述 价值
能见度 API 服务器可见性。 “Private”
“Public”

集群配置文件

名字 描述 价值
群集的域。 字符串
fipsValidatedModules 模块 如果使用 FIPS 验证的加密模块 “Disabled”
“Enabled”
oidc颁发者 工作负荷标识群集中托管 OIDC 颁发者的 URL。 字符串
pullSecret 群集的拉取机密。 字符串
资源组ID 群集资源组的 ID。 字符串
版本 群集的版本。 字符串

ConsoleProfile

名字 描述 价值

入口配置文件

名字 描述 价值
名字 入口配置文件名称。 字符串
能见度 入口可见性。 “Private”
“Public”

LoadBalancer配置文件

名字 描述 价值
managedOutboundIps 群集公共负载均衡器的所需托管出站 IP。 ManagedOutboundIP

ManagedOutboundIP

名字 描述 价值
计数 计数表示 Azure 为群集公共负载均衡器创建和管理的所需 IPv4 出站 IP 数。 允许的值为 1 - 20。 默认值为 1。 整数 (int)

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

MasterProfile

名字 描述 价值
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
子网 ID 主子网的 Azure 资源 ID。 字符串
vmSize 主 VM 的大小。 字符串

网络简介

名字 描述 价值
loadBalancer配置文件 群集负载均衡器配置文件。 LoadBalancer配置文件
outbound类型 用于出口流量的 OutboundType。 “Loadbalancer”
“UserDefinedRouting”
podCidr 用于 OpenShift/Kubernetes Pod 的 CIDR。 字符串
预配置 NSG 指定是否使用 NSG 预附加子网 “Disabled”
“Enabled”
serviceCidr 服务 用于 OpenShift/Kubernetes 服务的 CIDR。 字符串

OpenShiftClusterProperties

名字 描述 价值
apiserver简介 群集 API 服务器配置文件。 APIServerProfile
clusterProfile 群集配置文件。 集群配置文件
console配置文件 控制台配置文件。 ConsoleProfile
ingressProfiles (入口配置文件) 群集入口配置文件。 IngressProfile[]
masterProfile 群集主配置文件。 MasterProfile
网络简介 群集网络配置文件。 网络简介
platformWorkloadIdentity配置文件 工作负荷标识配置文件。 PlatformWorkloadIdentityProfile
provisioningState 群集预配状态。 “AdminUpdating”
“Canceled”
“创建”
“删除”
“Failed”
“Succeeded”
“正在更新”
servicePrincipal简介 群集服务主体配置文件。 ServicePrincipalProfile
worker配置文件 群集辅助角色配置文件。 工人档案

PlatformWorkloadIdentity

名字 描述 价值
资源ID PlatformWorkloadIdentity 资源的资源 ID 字符串

PlatformWorkloadIdentityProfile

名字 描述 价值
platformWorkloadIdentities platformWorkloadIdentity<>字典 PlatformWorkloadIdentityProfilePlatformWorkloadIdentities
upgradeableTo UpgradeableTo 存储一个 OpenShift 版本,工作负荷标识群集可以升级到 字符串

PlatformWorkloadIdentityProfilePlatformWorkloadIdentities

名字 描述 价值

ServicePrincipalProfile

名字 描述 价值
客户端 ID 用于群集的客户端 ID。 字符串
客户密钥 用于群集的客户端密码。 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

工人档案

名字 描述 价值
计数 辅助角色 VM 的数量。 整数 (int)
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
diskSizeGB 磁盘大小 辅助角色 VM 的磁盘大小。 整数 (int)
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
名字 辅助角色配置文件名称。 字符串
子网 ID 辅助角色子网的 Azure 资源 ID。 字符串
vmSize 辅助角色 VM 的大小。 字符串

用法示例

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 openShiftClusters 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2024-08-12-preview"
  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"
        oidcIssuer = "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

名字 描述 价值
标识 标识将有关群集 MSI 的信息存储在工作负荷标识群集中。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
名字 资源名称 string (必需)
parent_id 要向其应用此扩展资源的资源的 ID。 string (必需)
性能 群集属性。 OpenShiftClusterProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.RedHatOpenShift/openShiftClusters@2024-08-12-preview”

APIServerProfile

名字 描述 价值
能见度 API 服务器可见性。 “Private”
“Public”

集群配置文件

名字 描述 价值
群集的域。 字符串
fipsValidatedModules 模块 如果使用 FIPS 验证的加密模块 “Disabled”
“Enabled”
oidc颁发者 工作负荷标识群集中托管 OIDC 颁发者的 URL。 字符串
pullSecret 群集的拉取机密。 字符串
资源组ID 群集资源组的 ID。 字符串
版本 群集的版本。 字符串

ConsoleProfile

名字 描述 价值

入口配置文件

名字 描述 价值
名字 入口配置文件名称。 字符串
能见度 入口可见性。 “Private”
“Public”

LoadBalancer配置文件

名字 描述 价值
managedOutboundIps 群集公共负载均衡器的所需托管出站 IP。 ManagedOutboundIP

ManagedOutboundIP

名字 描述 价值
计数 计数表示 Azure 为群集公共负载均衡器创建和管理的所需 IPv4 出站 IP 数。 允许的值为 1 - 20。 默认值为 1。 整数 (int)

ManagedServiceIdentity

名字 描述 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

MasterProfile

名字 描述 价值
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
子网 ID 主子网的 Azure 资源 ID。 字符串
vmSize 主 VM 的大小。 字符串

网络简介

名字 描述 价值
loadBalancer配置文件 群集负载均衡器配置文件。 LoadBalancer配置文件
outbound类型 用于出口流量的 OutboundType。 “Loadbalancer”
“UserDefinedRouting”
podCidr 用于 OpenShift/Kubernetes Pod 的 CIDR。 字符串
预配置 NSG 指定是否使用 NSG 预附加子网 “Disabled”
“Enabled”
serviceCidr 服务 用于 OpenShift/Kubernetes 服务的 CIDR。 字符串

OpenShiftClusterProperties

名字 描述 价值
apiserver简介 群集 API 服务器配置文件。 APIServerProfile
clusterProfile 群集配置文件。 集群配置文件
console配置文件 控制台配置文件。 ConsoleProfile
ingressProfiles (入口配置文件) 群集入口配置文件。 IngressProfile[]
masterProfile 群集主配置文件。 MasterProfile
网络简介 群集网络配置文件。 网络简介
platformWorkloadIdentity配置文件 工作负荷标识配置文件。 PlatformWorkloadIdentityProfile
provisioningState 群集预配状态。 “AdminUpdating”
“Canceled”
“创建”
“删除”
“Failed”
“Succeeded”
“正在更新”
servicePrincipal简介 群集服务主体配置文件。 ServicePrincipalProfile
worker配置文件 群集辅助角色配置文件。 工人档案

PlatformWorkloadIdentity

名字 描述 价值
资源ID PlatformWorkloadIdentity 资源的资源 ID 字符串

PlatformWorkloadIdentityProfile

名字 描述 价值
platformWorkloadIdentities platformWorkloadIdentity<>字典 PlatformWorkloadIdentityProfilePlatformWorkloadIdentities
upgradeableTo UpgradeableTo 存储一个 OpenShift 版本,工作负荷标识群集可以升级到 字符串

PlatformWorkloadIdentityProfilePlatformWorkloadIdentities

名字 描述 价值

ServicePrincipalProfile

名字 描述 价值
客户端 ID 用于群集的客户端 ID。 字符串
客户密钥 用于群集的客户端密码。 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

工人档案

名字 描述 价值
计数 辅助角色 VM 的数量。 整数 (int)
diskEncryptionSetId 关联的 DiskEncryptionSet 的资源 ID(如果适用)。 字符串
diskSizeGB 磁盘大小 辅助角色 VM 的磁盘大小。 整数 (int)
encryptionAtHost 主虚拟机是否在主机上加密。 “Disabled”
“Enabled”
名字 辅助角色配置文件名称。 字符串
子网 ID 辅助角色子网的 Azure 资源 ID。 字符串
vmSize 辅助角色 VM 的大小。 字符串