共用方式為


Microsoft.HybridContainerService provisionedClusterInstances 2023-11-15-preview

Bicep 資源定義

provisionedClusterInstances 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.HybridContainerService/provisionedClusterInstances 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview' = {
  scope: resourceSymbolicName or scope
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  name: 'default'
  properties: {
    agentPoolProfiles: [
      {
        availabilityZones: [
          'string'
        ]
        count: int
        name: 'string'
        nodeImageVersion: 'string'
        osSKU: 'string'
        osType: 'string'
        vmSize: 'string'
      }
    ]
    cloudProviderProfile: {
      infraNetworkProfile: {
        vnetSubnetIds: [
          'string'
        ]
      }
    }
    controlPlane: {
      availabilityZones: [
        'string'
      ]
      controlPlaneEndpoint: {
        hostIP: 'string'
        port: int
      }
      count: int
      linuxProfile: {
        ssh: {
          publicKeys: [
            {
              keyData: 'string'
            }
          ]
        }
      }
      name: 'string'
      nodeImageVersion: 'string'
      osSKU: 'string'
      osType: 'string'
      vmSize: 'string'
    }
    kubernetesVersion: 'string'
    licenseProfile: {
      azureHybridBenefit: 'string'
    }
    linuxProfile: {
      ssh: {
        publicKeys: [
          {
            keyData: 'string'
          }
        ]
      }
    }
    networkProfile: {
      loadBalancerProfile: {
        count: int
      }
      networkPolicy: 'string'
      podCidr: 'string'
    }
  }
}

屬性值

CloudProviderProfile

名字 描述 價值
infraNetworkProfile InfraNetworkProfile - 布建叢集的基礎結構網路配置檔清單 CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

名字 描述 價值
vnetSubnetIds 對應至網络物件的 azure 資源的參考陣列,例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名字 描述 價值
hostIP API 伺服器的主機 IP 位址 字串
港口 API 伺服器的埠 int

ControlPlaneProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
controlPlaneEndpoint 控制平面的 API 伺服器端點 ControlPlaneEndpointProfileControlPlaneEndpoint
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
linuxProfile 容器服務叢集中Linux VM的配置檔。 LinuxProfileProperties
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

ExtendedLocation

名字 描述 價值
名字 擴充位置名稱。 字串
類型 擴充位置類型。 'CustomLocation'

LinuxProfileProperties

名字 描述 價值
ssh SSH - 在 Azure 上執行的 Linux 型 VM 的 SSH 組態。 LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

名字 描述 價值
publicKeys PublicKeys - 用來向 Linux 型 VM 進行驗證的 SSH 公鑰清單。 只預期指定一個索引鍵。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名字 描述 價值
keyData KeyData - 用來透過 SSH 向 VM 進行驗證的憑證公鑰。 憑證必須採用 PEM 格式,且不含標頭。 字串

Microsoft.HybridContainerService/provisionedClusterInstances

名字 描述 價值
extendedLocation 擴充位置定義 ExtendedLocation
名字 資源名稱 'default' (必要)
性能 布建叢集的所有屬性 ProvisionedClusterProperties
範圍 在與部署範圍不同的範圍內建立資源時,請使用 。 將此屬性設定為資源的符號名稱,以套用 擴充資源

NamedAgentPoolProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

NetworkProfile

名字 描述 價值
loadBalancerProfile LoadBalancerProfile - 叢集負載平衡器的配置檔。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - 用於建置 Kubernetes 網路的網路原則。 可能的值包括:『calico』、『flannel』。 預設值為 'calico' 'calico'
'flannel'
podCidr PodCidr - 使用 kubenet 時要從中指派 Pod IP 的 CIDR 表示法 IP 範圍。 字串

NetworkProfileLoadBalancerProfile

名字 描述 價值
計數 計數 - 負載平衡器 VM 的數目。 預設值為 0。 int

ProvisionedClusterLicenseProfile

名字 描述 價值
azureHybridBenefit 指出是否選擇 Azure Hybrid Benefit 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

名字 描述 價值
agentPoolProfiles 叢集的代理程式集區。 NamedAgentPoolProfile[]
cloudProviderProfile 基礎雲端基礎結構提供者屬性。 CloudProviderProfile
controlPlane ControlPlane - ControlPlane 設定 ControlPlaneProfile
kubernetesVersion KubernetesVersion - 建立受控叢集時所指定的 Kubernetes 版本。 字串
licenseProfile 已佈建叢集的授權配置檔。 ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile - 布建叢集中 Linux VM 的配置檔。 LinuxProfileProperties
networkProfile NetworkProfile - 網路組態的配置檔。 NetworkProfile

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
在 Azure Stack HCI 上建立 Kubernetes 叢集 此範本會在 Azure Stack HCI 23H2+ 版上建立 Kubernetes 叢集

ARM 樣本資源定義

provisionedClusterInstances 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.HybridContainerService/provisionedClusterInstances 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.HybridContainerService/provisionedClusterInstances",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "properties": {
    "agentPoolProfiles": [
      {
        "availabilityZones": [ "string" ],
        "count": "int",
        "name": "string",
        "nodeImageVersion": "string",
        "osSKU": "string",
        "osType": "string",
        "vmSize": "string"
      }
    ],
    "cloudProviderProfile": {
      "infraNetworkProfile": {
        "vnetSubnetIds": [ "string" ]
      }
    },
    "controlPlane": {
      "availabilityZones": [ "string" ],
      "controlPlaneEndpoint": {
        "hostIP": "string",
        "port": "int"
      },
      "count": "int",
      "linuxProfile": {
        "ssh": {
          "publicKeys": [
            {
              "keyData": "string"
            }
          ]
        }
      },
      "name": "string",
      "nodeImageVersion": "string",
      "osSKU": "string",
      "osType": "string",
      "vmSize": "string"
    },
    "kubernetesVersion": "string",
    "licenseProfile": {
      "azureHybridBenefit": "string"
    },
    "linuxProfile": {
      "ssh": {
        "publicKeys": [
          {
            "keyData": "string"
          }
        ]
      }
    },
    "networkProfile": {
      "loadBalancerProfile": {
        "count": "int"
      },
      "networkPolicy": "string",
      "podCidr": "string"
    }
  }
}

屬性值

CloudProviderProfile

名字 描述 價值
infraNetworkProfile InfraNetworkProfile - 布建叢集的基礎結構網路配置檔清單 CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

名字 描述 價值
vnetSubnetIds 對應至網络物件的 azure 資源的參考陣列,例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名字 描述 價值
hostIP API 伺服器的主機 IP 位址 字串
港口 API 伺服器的埠 int

ControlPlaneProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
controlPlaneEndpoint 控制平面的 API 伺服器端點 ControlPlaneEndpointProfileControlPlaneEndpoint
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
linuxProfile 容器服務叢集中Linux VM的配置檔。 LinuxProfileProperties
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

ExtendedLocation

名字 描述 價值
名字 擴充位置名稱。 字串
類型 擴充位置類型。 'CustomLocation'

LinuxProfileProperties

名字 描述 價值
ssh SSH - 在 Azure 上執行的 Linux 型 VM 的 SSH 組態。 LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

名字 描述 價值
publicKeys PublicKeys - 用來向 Linux 型 VM 進行驗證的 SSH 公鑰清單。 只預期指定一個索引鍵。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名字 描述 價值
keyData KeyData - 用來透過 SSH 向 VM 進行驗證的憑證公鑰。 憑證必須採用 PEM 格式,且不含標頭。 字串

Microsoft.HybridContainerService/provisionedClusterInstances

名字 描述 價值
apiVersion API 版本 '2023-11-15-preview'
extendedLocation 擴充位置定義 ExtendedLocation
名字 資源名稱 'default' (必要)
性能 布建叢集的所有屬性 ProvisionedClusterProperties
類型 資源類型 'Microsoft.HybridContainerService/provisionedClusterInstances'

NamedAgentPoolProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

NetworkProfile

名字 描述 價值
loadBalancerProfile LoadBalancerProfile - 叢集負載平衡器的配置檔。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - 用於建置 Kubernetes 網路的網路原則。 可能的值包括:『calico』、『flannel』。 預設值為 'calico' 'calico'
'flannel'
podCidr PodCidr - 使用 kubenet 時要從中指派 Pod IP 的 CIDR 表示法 IP 範圍。 字串

NetworkProfileLoadBalancerProfile

名字 描述 價值
計數 計數 - 負載平衡器 VM 的數目。 預設值為 0。 int

ProvisionedClusterLicenseProfile

名字 描述 價值
azureHybridBenefit 指出是否選擇 Azure Hybrid Benefit 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

名字 描述 價值
agentPoolProfiles 叢集的代理程式集區。 NamedAgentPoolProfile[]
cloudProviderProfile 基礎雲端基礎結構提供者屬性。 CloudProviderProfile
controlPlane ControlPlane - ControlPlane 設定 ControlPlaneProfile
kubernetesVersion KubernetesVersion - 建立受控叢集時所指定的 Kubernetes 版本。 字串
licenseProfile 已佈建叢集的授權配置檔。 ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile - 布建叢集中 Linux VM 的配置檔。 LinuxProfileProperties
networkProfile NetworkProfile - 網路組態的配置檔。 NetworkProfile

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
在 Azure Stack HCI 上建立 Kubernetes 叢集

部署至 Azure
此範本會在 Azure Stack HCI 23H2+ 版上建立 Kubernetes 叢集

Terraform (AzAPI 提供者) 資源定義

provisionedClusterInstances 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.HybridContainerService/provisionedClusterInstances 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      agentPoolProfiles = [
        {
          availabilityZones = [
            "string"
          ]
          count = int
          name = "string"
          nodeImageVersion = "string"
          osSKU = "string"
          osType = "string"
          vmSize = "string"
        }
      ]
      cloudProviderProfile = {
        infraNetworkProfile = {
          vnetSubnetIds = [
            "string"
          ]
        }
      }
      controlPlane = {
        availabilityZones = [
          "string"
        ]
        controlPlaneEndpoint = {
          hostIP = "string"
          port = int
        }
        count = int
        linuxProfile = {
          ssh = {
            publicKeys = [
              {
                keyData = "string"
              }
            ]
          }
        }
        name = "string"
        nodeImageVersion = "string"
        osSKU = "string"
        osType = "string"
        vmSize = "string"
      }
      kubernetesVersion = "string"
      licenseProfile = {
        azureHybridBenefit = "string"
      }
      linuxProfile = {
        ssh = {
          publicKeys = [
            {
              keyData = "string"
            }
          ]
        }
      }
      networkProfile = {
        loadBalancerProfile = {
          count = int
        }
        networkPolicy = "string"
        podCidr = "string"
      }
    }
  })
}

屬性值

CloudProviderProfile

名字 描述 價值
infraNetworkProfile InfraNetworkProfile - 布建叢集的基礎結構網路配置檔清單 CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

名字 描述 價值
vnetSubnetIds 對應至網络物件的 azure 資源的參考陣列,例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名字 描述 價值
hostIP API 伺服器的主機 IP 位址 字串
港口 API 伺服器的埠 int

ControlPlaneProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
controlPlaneEndpoint 控制平面的 API 伺服器端點 ControlPlaneEndpointProfileControlPlaneEndpoint
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
linuxProfile 容器服務叢集中Linux VM的配置檔。 LinuxProfileProperties
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

ExtendedLocation

名字 描述 價值
名字 擴充位置名稱。 字串
類型 擴充位置類型。 'CustomLocation'

LinuxProfileProperties

名字 描述 價值
ssh SSH - 在 Azure 上執行的 Linux 型 VM 的 SSH 組態。 LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

名字 描述 價值
publicKeys PublicKeys - 用來向 Linux 型 VM 進行驗證的 SSH 公鑰清單。 只預期指定一個索引鍵。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名字 描述 價值
keyData KeyData - 用來透過 SSH 向 VM 進行驗證的憑證公鑰。 憑證必須採用 PEM 格式,且不含標頭。 字串

Microsoft.HybridContainerService/provisionedClusterInstances

名字 描述 價值
extendedLocation 擴充位置定義 ExtendedLocation
名字 資源名稱 'default' (必要)
parent_id 要套用此延伸模組資源之資源的標識碼。 字串 (必要)
性能 布建叢集的所有屬性 ProvisionedClusterProperties
類型 資源類型 “Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview”

NamedAgentPoolProfile

名字 描述 價值
availabilityZones AvailabilityZones - 要用於節點的可用性區域清單。 將數據中心機架模型化為區域 string[]
計數 計數 - 裝載 Docker 容器的代理程式數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。 int
名字 訂用帳戶和資源群組內容中代理程式集區配置檔的唯一名稱。 字串
nodeImageVersion 節點映像的版本 字串
osSKU 指定代理程式集區所使用的 OS SKU。 如果 OSType 為 Linux,則預設值為 CBLMariner。 當OSType為 Windows 時,預設值為 Windows2019。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定 KubernetesVersion 的映射 OS 類型(Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - 代理程序集區 VM 的大小。 字串

NetworkProfile

名字 描述 價值
loadBalancerProfile LoadBalancerProfile - 叢集負載平衡器的配置檔。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - 用於建置 Kubernetes 網路的網路原則。 可能的值包括:『calico』、『flannel』。 預設值為 'calico' 'calico'
'flannel'
podCidr PodCidr - 使用 kubenet 時要從中指派 Pod IP 的 CIDR 表示法 IP 範圍。 字串

NetworkProfileLoadBalancerProfile

名字 描述 價值
計數 計數 - 負載平衡器 VM 的數目。 預設值為 0。 int

ProvisionedClusterLicenseProfile

名字 描述 價值
azureHybridBenefit 指出是否選擇 Azure Hybrid Benefit 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

名字 描述 價值
agentPoolProfiles 叢集的代理程式集區。 NamedAgentPoolProfile[]
cloudProviderProfile 基礎雲端基礎結構提供者屬性。 CloudProviderProfile
controlPlane ControlPlane - ControlPlane 設定 ControlPlaneProfile
kubernetesVersion KubernetesVersion - 建立受控叢集時所指定的 Kubernetes 版本。 字串
licenseProfile 已佈建叢集的授權配置檔。 ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile - 布建叢集中 Linux VM 的配置檔。 LinuxProfileProperties
networkProfile NetworkProfile - 網路組態的配置檔。 NetworkProfile