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 資源標識符列表（最大值 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
價值
authorizedIPRanges
IP 位址或 CIDR 可透過 SSH 存取佈建叢集中的 VM
字串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
價值
hostIP
Kubernetes API 伺服器的IP位址
字串
ExtendedLocation
名字
描述
價值
名字
擴充位置的 ARM 識別碼。
字串
類型
擴充位置類型。 允許的值：'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 Proxy 負載平衡器的配置檔。
NetworkProfileLoadBalancerProfile
networkPolicy
用於建置 Kubernetes 網路的網路原則。 可能的值包括：『calico』。
'calico'
podCidr
要從中指派 Pod IP 的 CIDR 表示法 IP 位址範圍。
字串
NetworkProfileLoadBalancerProfile
名字
描述
價值
計數
HA Proxy 負載平衡器 VM 的數目。 預設值為 0。
int
ProvisionedClusterLicenseProfile
名字
描述
價值
azureHybridBenefit
指出是否加入 Azure Hybrid Benefit。 默認值為 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
針對高載/批次規模等案例，您不希望 CA 在 kubernetes 排程器排程所有 Pod 之前採取行動，您可以告訴 CA 在排程特定年齡之前忽略未排程的 Pod。 預設值為 『0s』。 值必須是整數，後面接著單位（秒的 's'、'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 資源標識符列表（最大值 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
價值
authorizedIPRanges
IP 位址或 CIDR 可透過 SSH 存取佈建叢集中的 VM
字串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
價值
hostIP
Kubernetes API 伺服器的IP位址
字串
ExtendedLocation
名字
描述
價值
名字
擴充位置的 ARM 識別碼。
字串
類型
擴充位置類型。 允許的值：'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 Proxy 負載平衡器的配置檔。
NetworkProfileLoadBalancerProfile
networkPolicy
用於建置 Kubernetes 網路的網路原則。 可能的值包括：『calico』。
'calico'
podCidr
要從中指派 Pod IP 的 CIDR 表示法 IP 位址範圍。
字串
NetworkProfileLoadBalancerProfile
名字
描述
價值
計數
HA Proxy 負載平衡器 VM 的數目。 預設值為 0。
int
ProvisionedClusterLicenseProfile
名字
描述
價值
azureHybridBenefit
指出是否加入 Azure Hybrid Benefit。 默認值為 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
針對高載/批次規模等案例，您不希望 CA 在 kubernetes 排程器排程所有 Pod 之前採取行動，您可以告訴 CA 在排程特定年齡之前忽略未排程的 Pod。 預設值為 『0s』。 值必須是整數，後面接著單位（秒的 's'、'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 資源標識符列表（最大值 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
string[]
ClusterVMAccessProfile
名字
描述
價值
authorizedIPRanges
IP 位址或 CIDR 可透過 SSH 存取佈建叢集中的 VM
字串
ControlPlaneProfile
ControlPlaneProfileControlPlaneEndpoint
名字
描述
價值
hostIP
Kubernetes API 伺服器的IP位址
字串
ExtendedLocation
名字
描述
價值
名字
擴充位置的 ARM 識別碼。
字串
類型
擴充位置類型。 允許的值：'CustomLocation'
'CustomLocation'
LinuxProfileProperties
LinuxProfilePropertiesSsh
LinuxProfilePropertiesSshPublicKeysItem
名字
描述
價值
keyData
用來透過 SSH 向 VM 進行驗證的憑證公鑰。 憑證必須採用 PEM 格式，且不含標頭。
字串
Microsoft.HybridContainerService/provisionedClusterInstances
名字
描述
價值
extendedLocation
指向基礎結構的擴充位置
ExtendedLocation
名字
資源名稱
'default' （必要）
parent_id
要套用此延伸模組資源之資源的標識碼。
字串 （必要）
性能
已布建叢集的屬性。
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 Proxy 負載平衡器的配置檔。
NetworkProfileLoadBalancerProfile
networkPolicy
用於建置 Kubernetes 網路的網路原則。 可能的值包括：『calico』。
'calico'
podCidr
要從中指派 Pod IP 的 CIDR 表示法 IP 位址範圍。
字串
NetworkProfileLoadBalancerProfile
名字
描述
價值
計數
HA Proxy 負載平衡器 VM 的數目。 預設值為 0。
int
ProvisionedClusterLicenseProfile
名字
描述
價值
azureHybridBenefit
指出是否加入 Azure Hybrid Benefit。 默認值為 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
針對高載/批次規模等案例，您不希望 CA 在 kubernetes 排程器排程所有 Pod 之前採取行動，您可以告訴 CA 在排程特定年齡之前忽略未排程的 Pod。 預設值為 『0s』。 值必須是整數，後面接著單位（秒的 's'、'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
