ManagedClusterProperties interface
描述托管群集资源属性。
属性
| addon |
在群集上启用的附加功能列表。 |
| admin |
VM 管理员用户密码。 |
| admin |
VM 管理员用户名。 |
| allocated |
为默认负载均衡器后端池中的每个节点分配的 SNAT 出站端口数。 默认值为 0,它根据池大小提供动态端口分配。 |
| allow |
如果设置为 true,则 RDP 可以访问 VM。 默认 NSG 规则将打开 RDP 端口到 Internet,可以使用自定义网络安全规则重写该端口。 此设置的默认值为 false。 |
| application |
用于清理未使用版本的策略。 |
| auto |
此属性是用于群集证书的公共 CA 证书的入口点。它指定为创建的自定义 FQDN 所允许的重用级别,与公共 CA 证书的主题匹配。 |
| auxiliary |
群集的辅助子网。 |
| azure |
群集的 AAD 身份验证设置。 |
| client |
用于连接到群集的客户端连接的端口。 |
| clients | 允许管理群集的客户端证书。 |
| cluster |
群集证书的指纹列表。 |
| cluster |
群集的 Service Fabric 运行时版本。 clusterUpgradeMode 设置为“Manual”时,此属性是必需的。 若要获取新群集的可用 Service Fabric 版本列表,请使用 ClusterVersion API。 若要获取现有群集的可用版本列表,请使用 availableClusterVersions。 |
| cluster |
服务为群集资源生成了唯一标识符。 |
| cluster |
群集的当前状态。 |
| cluster |
指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。 默认情况下为 Wave0。 仅在 clusterUpgradeMode 设置为“Automatic”时 |
| cluster |
新的 Service Fabric 运行时版本可用时群集的升级模式。 |
| ddos |
指定与群集虚拟网络关联的 DDoS 网络保护计划的资源 ID。 |
| dns |
群集 dns 名称。 |
| enable |
为使用版本“latest”的 OS 映像创建的节点类型启用自动 OS 升级。 此设置的默认值为 false。 |
| enable |
如果为 true,则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。 这需要支持 TLS 版本 1.3 及更高版本。 如果使用基于令牌的身份验证,则必须定义 HttpGatewayTokenAuthConnectionPort。 |
| enable |
如果设置为 true,则会为群集使用的默认 VNet 创建 IPv6 地址空间。 创建群集后,无法更改此设置。 此设置的默认值为 false。 |
| enable |
启用仅启用出站流量的节点类型的创建。 如果设置,则将为启用了入站流量的节点类型创建单独的负载均衡器后端池。 只能在创建集群时设置。 |
| enable |
将此设置为 true 会将 IPv4 地址作为 IPv6 地址的 ServicePublicIP 链接。 只能在群集上启用 IPv6 时将其设置为 True。 |
| fabric |
要配置群集的自定义结构设置列表。 |
| fqdn | 与群集的公共负载均衡器关联的完全限定域名。 |
| http |
用于与群集建立 HTTP 连接的端口。 |
| http |
用于与群集建立基于令牌身份验证的 HTTPS 连接的端口。 不能设置为与 HttpGatewayEndpoint 相同的端口。 |
| ip |
与群集的默认公共 IP 地址关联的 IP 标记列表。 |
| ipv4Address | 与群集的公共负载均衡器关联的 IPv4 地址。 |
| ipv6Address | 如果启用了 IPv6,则群集的 IPv6 地址。 |
| load |
应用于群集公共负载均衡器的负载均衡规则。 |
| network |
应用于群集虚拟网络的自定义网络安全规则。 |
| provisioning |
托管群集资源的预配状态。 |
| public |
指定负载均衡器将从中分配公共 IPv4 地址的公共 IPv4 前缀的资源 ID。 创建群集后,无法更改此设置。 |
| public |
指定负载均衡器将从中分配公共 IPv6 地址的公共 IPv6 前缀的资源 ID。 创建群集后,无法更改此设置。 |
| service |
群集中子网的服务终结点。 |
| subnet |
如果指定,则会在此子网中创建群集的节点类型,而不是默认 VNet。 为群集指定的 networkSecurityRules 也应用于此子网。 创建群集后,无法更改此设置。 |
| upgrade |
升级群集时要使用的策略。 |
| use |
对于新群集,此参数指示它使用自带 VNet,但在节点类型级别指定子网;对于此类群集,节点类型需要 subnetId 属性。 |
| vm |
配置节点类型的 VM 映像。 此属性控制要用于群集的 Service Fabric 组件包。 允许的值为:“Windows”。 默认值为“Windows”。 |
| zonal |
指示群集是否具有区域复原能力。 |
| zonal |
指示跨 Az 群集的更新模式。 |
属性详细信息
addonFeatures
在群集上启用的附加功能列表。
addonFeatures?: string[]
属性值
string[]
adminPassword
VM 管理员用户密码。
adminPassword?: string
属性值
string
adminUserName
VM 管理员用户名。
adminUserName: string
属性值
string
allocatedOutboundPorts
为默认负载均衡器后端池中的每个节点分配的 SNAT 出站端口数。 默认值为 0,它根据池大小提供动态端口分配。
allocatedOutboundPorts?: number
属性值
number
allowRdpAccess
如果设置为 true,则 RDP 可以访问 VM。 默认 NSG 规则将打开 RDP 端口到 Internet,可以使用自定义网络安全规则重写该端口。 此设置的默认值为 false。
allowRdpAccess?: boolean
属性值
boolean
applicationTypeVersionsCleanupPolicy
用于清理未使用版本的策略。
applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy
属性值
autoGeneratedDomainNameLabelScope
此属性是用于群集证书的公共 CA 证书的入口点。它指定为创建的自定义 FQDN 所允许的重用级别,与公共 CA 证书的主题匹配。
autoGeneratedDomainNameLabelScope?: string
属性值
string
auxiliarySubnets
azureActiveDirectory
clientConnectionPort
用于连接到群集的客户端连接的端口。
clientConnectionPort?: number
属性值
number
clients
clusterCertificateThumbprints
群集证书的指纹列表。
clusterCertificateThumbprints?: string[]
属性值
string[]
clusterCodeVersion
群集的 Service Fabric 运行时版本。 clusterUpgradeMode 设置为“Manual”时,此属性是必需的。 若要获取新群集的可用 Service Fabric 版本列表,请使用 ClusterVersion API。 若要获取现有群集的可用版本列表,请使用 availableClusterVersions。
clusterCodeVersion?: string
属性值
string
clusterId
服务为群集资源生成了唯一标识符。
clusterId?: string
属性值
string
clusterState
群集的当前状态。
clusterState?: string
属性值
string
clusterUpgradeCadence
指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。 默认情况下为 Wave0。 仅在 clusterUpgradeMode 设置为“Automatic”时
clusterUpgradeCadence?: string
属性值
string
clusterUpgradeMode
新的 Service Fabric 运行时版本可用时群集的升级模式。
clusterUpgradeMode?: string
属性值
string
ddosProtectionPlanId
指定与群集虚拟网络关联的 DDoS 网络保护计划的资源 ID。
ddosProtectionPlanId?: string
属性值
string
dnsName
群集 dns 名称。
dnsName: string
属性值
string
enableAutoOSUpgrade
为使用版本“latest”的 OS 映像创建的节点类型启用自动 OS 升级。 此设置的默认值为 false。
enableAutoOSUpgrade?: boolean
属性值
boolean
enableHttpGatewayExclusiveAuthMode
如果为 true,则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。 这需要支持 TLS 版本 1.3 及更高版本。 如果使用基于令牌的身份验证,则必须定义 HttpGatewayTokenAuthConnectionPort。
enableHttpGatewayExclusiveAuthMode?: boolean
属性值
boolean
enableIpv6
如果设置为 true,则会为群集使用的默认 VNet 创建 IPv6 地址空间。 创建群集后,无法更改此设置。 此设置的默认值为 false。
enableIpv6?: boolean
属性值
boolean
enableOutboundOnlyNodeTypes
启用仅启用出站流量的节点类型的创建。 如果设置,则将为启用了入站流量的节点类型创建单独的负载均衡器后端池。 只能在创建集群时设置。
enableOutboundOnlyNodeTypes?: boolean
属性值
boolean
enableServicePublicIP
将此设置为 true 会将 IPv4 地址作为 IPv6 地址的 ServicePublicIP 链接。 只能在群集上启用 IPv6 时将其设置为 True。
enableServicePublicIP?: boolean
属性值
boolean
fabricSettings
fqdn
与群集的公共负载均衡器关联的完全限定域名。
fqdn?: string
属性值
string
httpGatewayConnectionPort
用于与群集建立 HTTP 连接的端口。
httpGatewayConnectionPort?: number
属性值
number
httpGatewayTokenAuthConnectionPort
用于与群集建立基于令牌身份验证的 HTTPS 连接的端口。 不能设置为与 HttpGatewayEndpoint 相同的端口。
httpGatewayTokenAuthConnectionPort?: number
属性值
number
ipTags
ipv4Address
与群集的公共负载均衡器关联的 IPv4 地址。
ipv4Address?: string
属性值
string
ipv6Address
如果启用了 IPv6,则群集的 IPv6 地址。
ipv6Address?: string
属性值
string
loadBalancingRules
networkSecurityRules
provisioningState
托管群集资源的预配状态。
provisioningState?: string
属性值
string
publicIPPrefixId
指定负载均衡器将从中分配公共 IPv4 地址的公共 IPv4 前缀的资源 ID。 创建群集后,无法更改此设置。
publicIPPrefixId?: string
属性值
string
publicIPv6PrefixId
指定负载均衡器将从中分配公共 IPv6 地址的公共 IPv6 前缀的资源 ID。 创建群集后,无法更改此设置。
publicIPv6PrefixId?: string
属性值
string
serviceEndpoints
subnetId
如果指定,则会在此子网中创建群集的节点类型,而不是默认 VNet。 为群集指定的 networkSecurityRules 也应用于此子网。 创建群集后,无法更改此设置。
subnetId?: string
属性值
string
upgradeDescription
useCustomVnet
对于新群集,此参数指示它使用自带 VNet,但在节点类型级别指定子网;对于此类群集,节点类型需要 subnetId 属性。
useCustomVnet?: boolean
属性值
boolean
vmImage
配置节点类型的 VM 映像。 此属性控制要用于群集的 Service Fabric 组件包。 允许的值为:“Windows”。 默认值为“Windows”。
vmImage?: string
属性值
string
zonalResiliency
指示群集是否具有区域复原能力。
zonalResiliency?: boolean
属性值
boolean
zonalUpdateMode
指示跨 Az 群集的更新模式。
zonalUpdateMode?: string
属性值
string