你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.RedHatOpenShift openShiftClusters 2020-04-30
Bicep 资源定义
可以使用目标操作部署 openShiftClusters 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30' = {
location: 'string'
name: 'string'
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'
}
]
}
tags: {
{customized property}: 'string'
}
}
属性值
APIServerProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 群集 API 服务器的 IP(不可变)。 | 字符串 |
url | 用于访问群集 API 服务器的 URL(不可变)。 | 字符串 |
能见度 | API 服务器可见性(不可变)。 | “Private” “Public” |
ClusterProfile
名字 | 描述 | 价值 |
---|---|---|
域 | 群集的域(不可变)。 | 字符串 |
pullSecret | 群集的拉取机密(不可变)。 | 字符串 |
resourceGroupId | 群集资源组的 ID(不可变)。 | 字符串 |
版本 | 群集的版本(不可变)。 | 字符串 |
ConsoleProfile
名字 | 描述 | 价值 |
---|---|---|
url | 用于访问群集控制台的 URL(不可变)。 | 字符串 |
IngressProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 入口的 IP(不可变)。 | 字符串 |
名字 | 入口配置文件名称。 必须是“default”(不可变)。 | 字符串 |
能见度 | 入口可见性(不可变)。 | “Private” “Public” |
MasterProfile
名字 | 描述 | 价值 |
---|---|---|
subnetId | 主子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 主 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |
Microsoft.RedHatOpenShift/openShiftClusters
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 群集属性。 | OpenShiftClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
NetworkProfile
名字 | 描述 | 价值 |
---|---|---|
podCidr | 用于 OpenShift/Kubernetes Pod 的 CIDR(不可变)。 | 字符串 |
serviceCidr | 用于 OpenShift/Kubernetes 服务(不可变)的 CIDR。 | 字符串 |
OpenShiftClusterProperties
名字 | 描述 | 价值 |
---|---|---|
apiserverProfile | 群集 API 服务器配置文件。 | APIServerProfile |
clusterProfile | 群集配置文件。 | ClusterProfile |
consoleProfile | 控制台配置文件。 | ConsoleProfile |
ingressProfiles | 群集入口配置文件。 | IngressProfile[] |
masterProfile | 群集主配置文件。 | MasterProfile |
networkProfile | 群集网络配置文件。 | NetworkProfile |
provisioningState | 群集预配状态(不可变)。 | “AdminUpdating” “创建” “删除” “Failed” “Succeeded” “正在更新” |
servicePrincipalProfile | 群集服务主体配置文件。 | ServicePrincipalProfile |
workerProfiles | 群集辅助角色配置文件。 | WorkerProfile[] |
ServicePrincipalProfile
名字 | 描述 | 价值 |
---|---|---|
clientId | 用于群集的客户端 ID(不可变)。 | 字符串 |
clientSecret | 用于群集的客户端密码(不可变)。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
WorkerProfile
名字 | 描述 | 价值 |
---|---|---|
计数 | 辅助角色 VM 的数量。 必须介于 3 到 20 之间(不可变)。 | int |
diskSizeGB | 辅助角色 VM 的磁盘大小。 必须为 128 或更高版本(不可变)。 | int |
名字 | 辅助角色配置文件名称。 必须是“worker”(不可变)。 | 字符串 |
subnetId | 辅助角色子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 辅助角色 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |
ARM 模板资源定义
可以使用目标操作部署 openShiftClusters 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.RedHatOpenShift/openShiftClusters",
"apiVersion": "2020-04-30",
"name": "string",
"location": "string",
"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"
}
]
},
"tags": {
"{customized property}": "string"
}
}
属性值
APIServerProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 群集 API 服务器的 IP(不可变)。 | 字符串 |
url | 用于访问群集 API 服务器的 URL(不可变)。 | 字符串 |
能见度 | API 服务器可见性(不可变)。 | “Private” “Public” |
ClusterProfile
名字 | 描述 | 价值 |
---|---|---|
域 | 群集的域(不可变)。 | 字符串 |
pullSecret | 群集的拉取机密(不可变)。 | 字符串 |
resourceGroupId | 群集资源组的 ID(不可变)。 | 字符串 |
版本 | 群集的版本(不可变)。 | 字符串 |
ConsoleProfile
名字 | 描述 | 价值 |
---|---|---|
url | 用于访问群集控制台的 URL(不可变)。 | 字符串 |
IngressProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 入口的 IP(不可变)。 | 字符串 |
名字 | 入口配置文件名称。 必须是“default”(不可变)。 | 字符串 |
能见度 | 入口可见性(不可变)。 | “Private” “Public” |
MasterProfile
名字 | 描述 | 价值 |
---|---|---|
subnetId | 主子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 主 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |
Microsoft.RedHatOpenShift/openShiftClusters
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | '2020-04-30' |
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 群集属性。 | OpenShiftClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
类型 | 资源类型 | “Microsoft.RedHatOpenShift/openShiftClusters” |
NetworkProfile
名字 | 描述 | 价值 |
---|---|---|
podCidr | 用于 OpenShift/Kubernetes Pod 的 CIDR(不可变)。 | 字符串 |
serviceCidr | 用于 OpenShift/Kubernetes 服务(不可变)的 CIDR。 | 字符串 |
OpenShiftClusterProperties
名字 | 描述 | 价值 |
---|---|---|
apiserverProfile | 群集 API 服务器配置文件。 | APIServerProfile |
clusterProfile | 群集配置文件。 | ClusterProfile |
consoleProfile | 控制台配置文件。 | ConsoleProfile |
ingressProfiles | 群集入口配置文件。 | IngressProfile[] |
masterProfile | 群集主配置文件。 | MasterProfile |
networkProfile | 群集网络配置文件。 | NetworkProfile |
provisioningState | 群集预配状态(不可变)。 | “AdminUpdating” “创建” “删除” “Failed” “Succeeded” “正在更新” |
servicePrincipalProfile | 群集服务主体配置文件。 | ServicePrincipalProfile |
workerProfiles | 群集辅助角色配置文件。 | WorkerProfile[] |
ServicePrincipalProfile
名字 | 描述 | 价值 |
---|---|---|
clientId | 用于群集的客户端 ID(不可变)。 | 字符串 |
clientSecret | 用于群集的客户端密码(不可变)。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
WorkerProfile
名字 | 描述 | 价值 |
---|---|---|
计数 | 辅助角色 VM 的数量。 必须介于 3 到 20 之间(不可变)。 | int |
diskSizeGB | 辅助角色 VM 的磁盘大小。 必须为 128 或更高版本(不可变)。 | int |
名字 | 辅助角色配置文件名称。 必须是“worker”(不可变)。 | 字符串 |
subnetId | 辅助角色子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 辅助角色 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 openShiftClusters 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.RedHatOpenShift/openShiftClusters 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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"
}
]
}
})
}
属性值
APIServerProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 群集 API 服务器的 IP(不可变)。 | 字符串 |
url | 用于访问群集 API 服务器的 URL(不可变)。 | 字符串 |
能见度 | API 服务器可见性(不可变)。 | “Private” “Public” |
ClusterProfile
名字 | 描述 | 价值 |
---|---|---|
域 | 群集的域(不可变)。 | 字符串 |
pullSecret | 群集的拉取机密(不可变)。 | 字符串 |
resourceGroupId | 群集资源组的 ID(不可变)。 | 字符串 |
版本 | 群集的版本(不可变)。 | 字符串 |
ConsoleProfile
名字 | 描述 | 价值 |
---|---|---|
url | 用于访问群集控制台的 URL(不可变)。 | 字符串 |
IngressProfile
名字 | 描述 | 价值 |
---|---|---|
ip | 入口的 IP(不可变)。 | 字符串 |
名字 | 入口配置文件名称。 必须是“default”(不可变)。 | 字符串 |
能见度 | 入口可见性(不可变)。 | “Private” “Public” |
MasterProfile
名字 | 描述 | 价值 |
---|---|---|
subnetId | 主子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 主 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |
Microsoft.RedHatOpenShift/openShiftClusters
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 群集属性。 | OpenShiftClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 |
类型 | 资源类型 | “Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30” |
NetworkProfile
名字 | 描述 | 价值 |
---|---|---|
podCidr | 用于 OpenShift/Kubernetes Pod 的 CIDR(不可变)。 | 字符串 |
serviceCidr | 用于 OpenShift/Kubernetes 服务(不可变)的 CIDR。 | 字符串 |
OpenShiftClusterProperties
名字 | 描述 | 价值 |
---|---|---|
apiserverProfile | 群集 API 服务器配置文件。 | APIServerProfile |
clusterProfile | 群集配置文件。 | ClusterProfile |
consoleProfile | 控制台配置文件。 | ConsoleProfile |
ingressProfiles | 群集入口配置文件。 | IngressProfile[] |
masterProfile | 群集主配置文件。 | MasterProfile |
networkProfile | 群集网络配置文件。 | NetworkProfile |
provisioningState | 群集预配状态(不可变)。 | “AdminUpdating” “创建” “删除” “Failed” “Succeeded” “正在更新” |
servicePrincipalProfile | 群集服务主体配置文件。 | ServicePrincipalProfile |
workerProfiles | 群集辅助角色配置文件。 | WorkerProfile[] |
ServicePrincipalProfile
名字 | 描述 | 价值 |
---|---|---|
clientId | 用于群集的客户端 ID(不可变)。 | 字符串 |
clientSecret | 用于群集的客户端密码(不可变)。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
WorkerProfile
名字 | 描述 | 价值 |
---|---|---|
计数 | 辅助角色 VM 的数量。 必须介于 3 到 20 之间(不可变)。 | int |
diskSizeGB | 辅助角色 VM 的磁盘大小。 必须为 128 或更高版本(不可变)。 | int |
名字 | 辅助角色配置文件名称。 必须是“worker”(不可变)。 | 字符串 |
subnetId | 辅助角色子网的 Azure 资源 ID(不可变)。 | 字符串 |
vmSize | 辅助角色 VM 的大小(不可变)。 | “Standard_D2s_v3” “Standard_D4s_v3” “Standard_D8s_v3” |