你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn 。
Microsoft.HybridContainerService provisionedClusterInstances 2024-01-01
本文内容
Bicep 资源定义
可以使用目标操作部署 provisionedClusterInstances 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.HybridContainerService/provisionedClusterInstances 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.HybridContainerService/provisionedClusterInstances@2024-01-01' = {
scope: resourceSymbolicName or scope
extendedLocation: {
name: 'string'
type: 'string'
}
name: 'default'
properties: {
agentPoolProfiles: [
{
count: int
enableAutoScaling: bool
maxCount: int
maxPods: int
minCount: int
name: 'string'
nodeLabels: {
{customized property}: 'string'
}
nodeTaints: [
'string'
]
osSKU: 'string'
osType: 'string'
vmSize: 'string'
}
]
autoScalerProfile: {
balance-similar-node-groups: 'string'
expander: 'string'
max-empty-bulk-delete: 'string'
max-graceful-termination-sec: 'string'
max-node-provision-time: 'string'
max-total-unready-percentage: 'string'
new-pod-scale-up-delay: 'string'
ok-total-unready-count: 'string'
scale-down-delay-after-add: 'string'
scale-down-delay-after-delete: 'string'
scale-down-delay-after-failure: 'string'
scale-down-unneeded-time: 'string'
scale-down-unready-time: 'string'
scale-down-utilization-threshold: 'string'
scan-interval: 'string'
skip-nodes-with-local-storage: 'string'
skip-nodes-with-system-pods: 'string'
}
cloudProviderProfile: {
infraNetworkProfile: {
vnetSubnetIds: [
'string'
]
}
}
clusterVMAccessProfile: {
authorizedIPRanges: 'string'
}
controlPlane: {
controlPlaneEndpoint: {
hostIP: 'string'
}
count: int
vmSize: 'string'
}
kubernetesVersion: 'string'
licenseProfile: {
azureHybridBenefit: 'string'
}
linuxProfile: {
ssh: {
publicKeys: [
{
keyData: 'string'
}
]
}
}
networkProfile: {
loadBalancerProfile: {
count: int
}
networkPolicy: 'string'
podCidr: 'string'
}
storageProfile: {
nfsCsiDriver: {
enabled: bool
}
smbCsiDriver: {
enabled: bool
}
}
}
}
属性值
AgentPoolProfileNodeLabels
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
名字
描述
价值
vnetSubnetIds
基础结构网络对象的 ARM 资源 ID 列表（最大为 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
价值
authorizedIPRanges
用于通过 SSH 访问预配群集中的 VM 的 IP 地址或 CIDR
字符串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
价值
hostIP
Kubernetes API 服务器的 IP 地址
字符串
ExtendedLocation
名字
描述
价值
名字
扩展位置的 ARM ID。
字符串
类型
扩展位置类型。 允许的值：“CustomLocation”
“CustomLocation”
LinuxProfileProperties
LinuxProfilePropertiesSsh
LinuxProfilePropertiesSshPublicKeysItem
名字
描述
价值
keyData
用于通过 SSH 向 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式（带或不带标头）。
字符串
Microsoft.HybridContainerService/provisionedClusterInstances
NamedAgentPoolProfile
名字
描述
价值
计数
代理池中的节点数。 默认值为 1。
int
enableAutoScaling
是否启用自动缩放程序。 默认值为 false
bool
maxCount
自动缩放的最大节点数
int
maxPods
可在节点上运行的 Pod 的最大数目。
int
minCount
自动缩放的最小节点数
int
名字
预配群集上下文中默认代理池的唯一名称。 默认值为 <clusterName>-nodepool1
字符串
nodeLabels
要跨代理池中的所有节点保留的节点标签。
AgentPoolProfileNodeLabels
nodeTaints
在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
string[]
osSKU
指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。
“CBLMariner”
osType
特定的 KubernetesVersion 映像 OS 类型（Linux、Windows）
“Linux”
vmSize
代理池节点 VM 的 VM SKU 大小。
字符串
NetworkProfile
名字
描述
价值
loadBalancerProfile
HA 代理负载均衡器的配置文件。
NetworkProfileLoadBalancerProfile
networkPolicy
用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。
“calico”
podCidr
要从中分配 Pod IP 的 CIDR 表示法 IP 地址范围。
字符串
NetworkProfileLoadBalancerProfile
名字
描述
价值
计数
HA 代理负载均衡器 VM 的数量。 默认值为 0。
int
ProvisionedClusterLicenseProfile
名字
描述
价值
azureHybridBenefit
指示是否选择加入 Azure 混合权益。 默认值为 false
“False”
ProvisionedClusterProperties
ProvisionedClusterPropertiesAutoScalerProfile
名字
描述
价值
balance-similar-node-groups
有效值为“true”和“false”
字符串
膨胀
如果未指定，则默认值为“random”。 有关详细信息，请参阅 扩展器 。
“最不浪费”
max-empty-bulk-delete
默认值为 10。
字符串
max-graceful-termination-sec
默认值为 600。
字符串
max-node-provision-time
默认值为“15m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
max-total-unready-percentage
默认值为 45。 最大值为 100，最小值为 0。
字符串
new-pod-scale-up-delay
对于在 kubernetes 计划程序可以计划所有 Pod 之前不希望 CA 执行操作的突发/批处理缩放方案，可以告诉 CA 在某个年龄之前忽略未计划的 Pod。 默认值为“0s”。 值必须是一个整数，后跟一个单位（以秒为单位，“m”表示分钟，“h”表示小时等）。
字符串
ok-total-unready-count
这必须是整数。 默认值为 3。
字符串
scale-down-delay-after-add
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-delete
默认值为扫描间隔。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-failure
默认值为“3m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unneed-time
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unready-time
默认值为“20m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-utilization-threshold
默认值为“0.5”。
字符串
scan-interval
默认值为“10”。 值必须是整数秒数。
字符串
skip-nodes-with-local-storage
默认值为 true。
字符串
skip-nodes-with-system-pods
默认值为 true。
字符串
StorageProfile
StorageProfileNfsCSIDriver
名字
描述
价值
启用
指示是否启用 NFS CSI 驱动程序。 默认值为 true。
bool
StorageProfileSmbCSIDriver
名字
描述
价值
启用
指示是否启用 SMB CSI 驱动程序。 默认值为 true。
bool
快速入门示例
以下快速入门示例部署此资源类型。
Bicep 文件
描述
在 Azure Stack HCI 上创建 Kubernetes 群集
此模板在 Azure Stack HCI 版本 23H2+ 上创建 Kubernetes 群集
ARM 模板资源定义
可以使用目标操作部署 provisionedClusterInstances 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.HybridContainerService/provisionedClusterInstances 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.HybridContainerService/provisionedClusterInstances",
"apiVersion": "2024-01-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"properties": {
"agentPoolProfiles": [
{
"count": "int",
"enableAutoScaling": "bool",
"maxCount": "int",
"maxPods": "int",
"minCount": "int",
"name": "string",
"nodeLabels": {
"{customized property}": "string"
},
"nodeTaints": [ "string" ],
"osSKU": "string",
"osType": "string",
"vmSize": "string"
}
],
"autoScalerProfile": {
"balance-similar-node-groups": "string",
"expander": "string",
"max-empty-bulk-delete": "string",
"max-graceful-termination-sec": "string",
"max-node-provision-time": "string",
"max-total-unready-percentage": "string",
"new-pod-scale-up-delay": "string",
"ok-total-unready-count": "string",
"scale-down-delay-after-add": "string",
"scale-down-delay-after-delete": "string",
"scale-down-delay-after-failure": "string",
"scale-down-unneeded-time": "string",
"scale-down-unready-time": "string",
"scale-down-utilization-threshold": "string",
"scan-interval": "string",
"skip-nodes-with-local-storage": "string",
"skip-nodes-with-system-pods": "string"
},
"cloudProviderProfile": {
"infraNetworkProfile": {
"vnetSubnetIds": [ "string" ]
}
},
"clusterVMAccessProfile": {
"authorizedIPRanges": "string"
},
"controlPlane": {
"controlPlaneEndpoint": {
"hostIP": "string"
},
"count": "int",
"vmSize": "string"
},
"kubernetesVersion": "string",
"licenseProfile": {
"azureHybridBenefit": "string"
},
"linuxProfile": {
"ssh": {
"publicKeys": [
{
"keyData": "string"
}
]
}
},
"networkProfile": {
"loadBalancerProfile": {
"count": "int"
},
"networkPolicy": "string",
"podCidr": "string"
},
"storageProfile": {
"nfsCsiDriver": {
"enabled": "bool"
},
"smbCsiDriver": {
"enabled": "bool"
}
}
}
}
属性值
AgentPoolProfileNodeLabels
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
名字
描述
价值
vnetSubnetIds
基础结构网络对象的 ARM 资源 ID 列表（最大为 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
价值
authorizedIPRanges
用于通过 SSH 访问预配群集中的 VM 的 IP 地址或 CIDR
字符串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
价值
hostIP
Kubernetes API 服务器的 IP 地址
字符串
ExtendedLocation
名字
描述
价值
名字
扩展位置的 ARM ID。
字符串
类型
扩展位置类型。 允许的值：“CustomLocation”
“CustomLocation”
LinuxProfileProperties
LinuxProfilePropertiesSsh
LinuxProfilePropertiesSshPublicKeysItem
名字
描述
价值
keyData
用于通过 SSH 向 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式（带或不带标头）。
字符串
Microsoft.HybridContainerService/provisionedClusterInstances
名字
描述
价值
apiVersion
API 版本
'2024-01-01'
extendedLocation
指向底层基础结构的扩展位置
ExtendedLocation
名字
资源名称
“default”（必需）
性能
预配群集的属性。
ProvisionedClusterProperties
类型
资源类型
“Microsoft.HybridContainerService/provisionedClusterInstances”
NamedAgentPoolProfile
名字
描述
价值
计数
代理池中的节点数。 默认值为 1。
int
enableAutoScaling
是否启用自动缩放程序。 默认值为 false
bool
maxCount
自动缩放的最大节点数
int
maxPods
可在节点上运行的 Pod 的最大数目。
int
minCount
自动缩放的最小节点数
int
名字
预配群集上下文中默认代理池的唯一名称。 默认值为 <clusterName>-nodepool1
字符串
nodeLabels
要跨代理池中的所有节点保留的节点标签。
AgentPoolProfileNodeLabels
nodeTaints
在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
string[]
osSKU
指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。
“CBLMariner”
osType
特定的 KubernetesVersion 映像 OS 类型（Linux、Windows）
“Linux”
vmSize
代理池节点 VM 的 VM SKU 大小。
字符串
NetworkProfile
名字
描述
价值
loadBalancerProfile
HA 代理负载均衡器的配置文件。
NetworkProfileLoadBalancerProfile
networkPolicy
用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。
“calico”
podCidr
要从中分配 Pod IP 的 CIDR 表示法 IP 地址范围。
字符串
NetworkProfileLoadBalancerProfile
名字
描述
价值
计数
HA 代理负载均衡器 VM 的数量。 默认值为 0。
int
ProvisionedClusterLicenseProfile
名字
描述
价值
azureHybridBenefit
指示是否选择加入 Azure 混合权益。 默认值为 false
“False”
ProvisionedClusterProperties
ProvisionedClusterPropertiesAutoScalerProfile
名字
描述
价值
balance-similar-node-groups
有效值为“true”和“false”
字符串
膨胀
如果未指定，则默认值为“random”。 有关详细信息，请参阅 扩展器 。
“最不浪费”
max-empty-bulk-delete
默认值为 10。
字符串
max-graceful-termination-sec
默认值为 600。
字符串
max-node-provision-time
默认值为“15m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
max-total-unready-percentage
默认值为 45。 最大值为 100，最小值为 0。
字符串
new-pod-scale-up-delay
对于在 kubernetes 计划程序可以计划所有 Pod 之前不希望 CA 执行操作的突发/批处理缩放方案，可以告诉 CA 在某个年龄之前忽略未计划的 Pod。 默认值为“0s”。 值必须是一个整数，后跟一个单位（以秒为单位，“m”表示分钟，“h”表示小时等）。
字符串
ok-total-unready-count
这必须是整数。 默认值为 3。
字符串
scale-down-delay-after-add
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-delete
默认值为扫描间隔。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-failure
默认值为“3m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unneed-time
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unready-time
默认值为“20m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-utilization-threshold
默认值为“0.5”。
字符串
scan-interval
默认值为“10”。 值必须是整数秒数。
字符串
skip-nodes-with-local-storage
默认值为 true。
字符串
skip-nodes-with-system-pods
默认值为 true。
字符串
StorageProfile
StorageProfileNfsCSIDriver
名字
描述
价值
启用
指示是否启用 NFS CSI 驱动程序。 默认值为 true。
bool
StorageProfileSmbCSIDriver
名字
描述
价值
启用
指示是否启用 SMB CSI 驱动程序。 默认值为 true。
bool
快速入门模板
以下快速入门模板部署此资源类型。
模板
描述
在 Azure Stack HCI 上创建 Kubernetes 群集
此模板在 Azure Stack HCI 版本 23H2+ 上创建 Kubernetes 群集
可以使用目标操作部署 provisionedClusterInstances 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志 。
若要创建 Microsoft.HybridContainerService/provisionedClusterInstances 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridContainerService/provisionedClusterInstances@2024-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
extendedLocation = {
name = "string"
type = "string"
}
properties = {
agentPoolProfiles = [
{
count = int
enableAutoScaling = bool
maxCount = int
maxPods = int
minCount = int
name = "string"
nodeLabels = {
{customized property} = "string"
}
nodeTaints = [
"string"
]
osSKU = "string"
osType = "string"
vmSize = "string"
}
]
autoScalerProfile = {
balance-similar-node-groups = "string"
expander = "string"
max-empty-bulk-delete = "string"
max-graceful-termination-sec = "string"
max-node-provision-time = "string"
max-total-unready-percentage = "string"
new-pod-scale-up-delay = "string"
ok-total-unready-count = "string"
scale-down-delay-after-add = "string"
scale-down-delay-after-delete = "string"
scale-down-delay-after-failure = "string"
scale-down-unneeded-time = "string"
scale-down-unready-time = "string"
scale-down-utilization-threshold = "string"
scan-interval = "string"
skip-nodes-with-local-storage = "string"
skip-nodes-with-system-pods = "string"
}
cloudProviderProfile = {
infraNetworkProfile = {
vnetSubnetIds = [
"string"
]
}
}
clusterVMAccessProfile = {
authorizedIPRanges = "string"
}
controlPlane = {
controlPlaneEndpoint = {
hostIP = "string"
}
count = int
vmSize = "string"
}
kubernetesVersion = "string"
licenseProfile = {
azureHybridBenefit = "string"
}
linuxProfile = {
ssh = {
publicKeys = [
{
keyData = "string"
}
]
}
}
networkProfile = {
loadBalancerProfile = {
count = int
}
networkPolicy = "string"
podCidr = "string"
}
storageProfile = {
nfsCsiDriver = {
enabled = bool
}
smbCsiDriver = {
enabled = bool
}
}
}
})
}
属性值
AgentPoolProfileNodeLabels
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
名字
描述
价值
vnetSubnetIds
基础结构网络对象的 ARM 资源 ID 列表（最大为 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
价值
authorizedIPRanges
用于通过 SSH 访问预配群集中的 VM 的 IP 地址或 CIDR
字符串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
价值
hostIP
Kubernetes API 服务器的 IP 地址
字符串
ExtendedLocation
名字
描述
价值
名字
扩展位置的 ARM ID。
字符串
类型
扩展位置类型。 允许的值：“CustomLocation”
“CustomLocation”
LinuxProfileProperties
LinuxProfilePropertiesSsh
LinuxProfilePropertiesSshPublicKeysItem
名字
描述
价值
keyData
用于通过 SSH 向 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式（带或不带标头）。
字符串
Microsoft.HybridContainerService/provisionedClusterInstances
名字
描述
价值
extendedLocation
指向底层基础结构的扩展位置
ExtendedLocation
名字
资源名称
“default”（必需）
parent_id
要向其应用此扩展资源的资源的 ID。
string （必需）
性能
预配群集的属性。
ProvisionedClusterProperties
类型
资源类型
“Microsoft.HybridContainerService/provisionedClusterInstances@2024-01-01”
NamedAgentPoolProfile
名字
描述
价值
计数
代理池中的节点数。 默认值为 1。
int
enableAutoScaling
是否启用自动缩放程序。 默认值为 false
bool
maxCount
自动缩放的最大节点数
int
maxPods
可在节点上运行的 Pod 的最大数目。
int
minCount
自动缩放的最小节点数
int
名字
预配群集上下文中默认代理池的唯一名称。 默认值为 <clusterName>-nodepool1
字符串
nodeLabels
要跨代理池中的所有节点保留的节点标签。
AgentPoolProfileNodeLabels
nodeTaints
在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
string[]
osSKU
指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。
“CBLMariner”
osType
特定的 KubernetesVersion 映像 OS 类型（Linux、Windows）
“Linux”
vmSize
代理池节点 VM 的 VM SKU 大小。
字符串
NetworkProfile
名字
描述
价值
loadBalancerProfile
HA 代理负载均衡器的配置文件。
NetworkProfileLoadBalancerProfile
networkPolicy
用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。
“calico”
podCidr
要从中分配 Pod IP 的 CIDR 表示法 IP 地址范围。
字符串
NetworkProfileLoadBalancerProfile
名字
描述
价值
计数
HA 代理负载均衡器 VM 的数量。 默认值为 0。
int
ProvisionedClusterLicenseProfile
名字
描述
价值
azureHybridBenefit
指示是否选择加入 Azure 混合权益。 默认值为 false
“False”
ProvisionedClusterProperties
ProvisionedClusterPropertiesAutoScalerProfile
名字
描述
价值
balance-similar-node-groups
有效值为“true”和“false”
字符串
膨胀
如果未指定，则默认值为“random”。 有关详细信息，请参阅 扩展器 。
“最不浪费”
max-empty-bulk-delete
默认值为 10。
字符串
max-graceful-termination-sec
默认值为 600。
字符串
max-node-provision-time
默认值为“15m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
max-total-unready-percentage
默认值为 45。 最大值为 100，最小值为 0。
字符串
new-pod-scale-up-delay
对于在 kubernetes 计划程序可以计划所有 Pod 之前不希望 CA 执行操作的突发/批处理缩放方案，可以告诉 CA 在某个年龄之前忽略未计划的 Pod。 默认值为“0s”。 值必须是一个整数，后跟一个单位（以秒为单位，“m”表示分钟，“h”表示小时等）。
字符串
ok-total-unready-count
这必须是整数。 默认值为 3。
字符串
scale-down-delay-after-add
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-delete
默认值为扫描间隔。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-delay-after-failure
默认值为“3m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unneed-time
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-unready-time
默认值为“20m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
字符串
scale-down-utilization-threshold
默认值为“0.5”。
字符串
scan-interval
默认值为“10”。 值必须是整数秒数。
字符串
skip-nodes-with-local-storage
默认值为 true。
字符串
skip-nodes-with-system-pods
默认值为 true。
字符串
StorageProfile
StorageProfileNfsCSIDriver
名字
描述
价值
启用
指示是否启用 NFS CSI 驱动程序。 默认值为 true。
bool
StorageProfileSmbCSIDriver
名字
描述
价值
启用
指示是否启用 SMB CSI 驱动程序。 默认值为 true。
bool
