你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.HybridContainerService provisionedClusterInstances 2023-11-15-preview

• 最新
• 2024-01-01
• 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 混合权益	“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 混合权益	“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 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	要向其应用此扩展资源的资源的 ID。	string （必需）
性能	预配群集的所有属性	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 混合权益	“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