通过

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

provisioned Cluster Instances - Get

  • 参考
服务:
Hybrid Container Service
API 版本:
2024-01-01

获取预配的群集实例

GET https://management.azure.com/{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default?api-version=2024-01-01

URI 参数

名称 在 必需 类型 说明
connectedClusterResourceUri
 path True

string

连接的群集资源的完全限定的 Azure 资源管理器标识符。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

provisionedCluster

获取 provisionedClusterInstances 资源
Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GetProvisionedClusterInstance

示例请求

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default?api-version=2024-01-01

示例响应

状态代码:
200 
{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/test-hybridakscluster/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default",
  "name": "test-hybridakscluster",
  "type": "Microsoft.HybridContainerService/provisionedClusterInstances",
  "extendedLocation": {
    "name": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation",
    "type": "CustomLocation"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "controlPlane": {
      "count": 1,
      "vmSize": "Standard_A4_v2"
    },
    "kubernetesVersion": "v1.20.5",
    "networkProfile": {
      "networkPolicy": "calico",
      "podCidr": "10.244.0.0/16"
    },
    "agentPoolProfiles": [
      {
        "name": "default-nodepool-1",
        "count": 1,
        "vmSize": "Standard_A4_v2",
        "osType": "Linux"
      }
    ],
    "linuxProfile": {
      "ssh": {
        "publicKeys": [
          {
            "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCY......."
          }
        ]
      }
    },
    "cloudProviderProfile": {
      "infraNetworkProfile": {
        "vnetSubnetIds": [
          "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.AzureStackHCI/logicalNetworks/test-vnet-static"
        ]
      }
    },
    "licenseProfile": {
      "azureHybridBenefit": "NotApplicable"
    }
  }
}

定义

名称 说明
addonPhase

已预配群集上加载项或组件的观察阶段。 可能的值包括：“pending”、“provisioning”、“provisioning {HelmChartInstalled}”、“provisioning {MSICertificateDownloaded}”、“provisioned”、“delete”、“failed”、“upgrade”
AddonStatusProfile

加载项和其他 kubernetes 组件的状态配置文件
AutoScalerProfile

为预配的群集启用自动缩放时，要应用于群集自动缩放程序的参数。
AzureHybridBenefit

指示是否选择加入 Azure 混合权益。 默认值为 false
CloudProviderProfile

预配群集的基础云基础结构提供程序的配置文件。
ClusterVMAccessProfile

预配群集中 VM 的 SSH 受限访问配置文件。
ControlPlaneEndpoint

Kubernetes API 服务器的 IP 地址
ControlPlaneProfile

预配群集的控制平面节点的属性
createdByType

创建资源的标识的类型。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
expander

纵向扩展时要使用的扩展器
ExtendedLocation

指向底层基础结构的扩展位置
ExtendedLocationTypes

扩展位置类型。 允许的值：“CustomLocation”
InfraNetworkProfile

预配群集使用的基础结构网络的配置文件
LinuxProfileProperties

预配群集的控制平面和节点池 VM 的 SSH 配置文件。
LoadBalancerProfile

HA 代理负载均衡器的配置文件。
NamedAgentPoolProfile

默认代理池的配置文件以及名称参数
networkPolicy

用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。
NetworkProfile

预配群集的网络配置文件。
OSSKU

指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。
osType

用于为 VM 指定 OS 类型的 OSType。 从 Linux 和 Windows 中进行选择。 默认为 Linux。 可能的值包括：“Linux”、“Windows”
provisionedCluster

预配的群集资源定义。
ProvisionedClusterLicenseProfile

预配群集的许可证配置文件。
provisionedClusterProperties

预配群集的属性。
PublicKeys

用于通过 VM 进行身份验证的 SSH 公钥列表。 最多可以指定 1 个键。
ResourceProvisioningState

资源的预配状态
Ssh

预配群集的 VM 的 SSH 配置。
Status

已预配群集的观察状态。
StorageProfile

预配群集的存储配置文件。
StorageProfileNfsCSIDriver

存储配置文件的 NFS CSI 驱动程序设置。
StorageProfileSmbCSIDriver

存储配置文件的 SMB CSI 驱动程序设置。
systemData

与创建和上次修改资源相关的元数据。

addonPhase

枚举

已预配群集上加载项或组件的观察阶段。 可能的值包括：“pending”、“provisioning”、“provisioning {HelmChartInstalled}”、“provisioning {MSICertificateDownloaded}”、“provisioned”、“delete”、“failed”、“upgrade”

值 说明
deleting
failed
pending
provisioned
provisioning
provisioning {HelmChartInstalled}
provisioning {MSICertificateDownloaded}
upgrading

AddonStatusProfile

Object

加载项和其他 kubernetes 组件的状态配置文件

名称 类型 说明
errorMessage

string

加载项或组件中观察到的错误消息
name

string

加载项或组件的名称
phase

addonPhase

已预配群集上加载项或组件的观察阶段。 可能的值包括：“pending”、“provisioning”、“provisioning {HelmChartInstalled}”、“provisioning {MSICertificateDownloaded}”、“provisioned”、“delete”、“failed”、“upgrade”
ready

boolean

指示加载项或组件是否已准备就绪

AutoScalerProfile

Object

为预配的群集启用自动缩放时，要应用于群集自动缩放程序的参数。

名称 类型 说明
balance-similar-node-groups

string

检测类似的节点池，并平衡它们之间的节点数。
有效值为“true”和“false”
expander

expander

纵向扩展时要使用的扩展器
如果未指定，则默认值为“random”。 有关详细信息，请参阅 扩展器。
max-empty-bulk-delete

string

可以同时删除的最大空节点数。 这必须是正整数。
默认值为 10。
max-graceful-termination-sec

string

群集自动缩放程序在尝试缩减节点时等待 Pod 终止的最大秒数。
默认值为 600。
max-node-provision-time

string

自动缩放程序等待预配节点的最长时间。
默认值为“15m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
max-total-unready-percentage

string

群集中未读节点的最大百分比。 超过此百分比后，群集自动缩放程序将停止作。
默认值为 45。 最大值为 100，最小值为 0。
new-pod-scale-up-delay

string

在某个年龄之前忽略未计划的 Pod。
对于在 kubernetes 计划程序可以计划所有 Pod 之前不希望 CA 执行作的突发/批处理缩放方案，可以告诉 CA 在某个年龄之前忽略未计划的 Pod。 默认值为“0s”。 值必须是一个整数，后跟一个单位（以秒为单位，“m”表示分钟，“h”表示小时等）。
ok-total-unready-count

string

允许的未读节点数，而不考虑最大总未读百分比。
这必须是整数。 默认值为 3。
scale-down-delay-after-add

string

纵向扩展后，纵向缩减评估的恢复时间
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
scale-down-delay-after-delete

string

缩减评估的节点删除后多长时间才能恢复。
默认值为扫描间隔。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
scale-down-delay-after-failure

string

纵向缩减失败后，纵向缩减评估的恢复时间。
默认值为“3m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
scale-down-unneeded-time

string

节点在有资格缩减之前，应该不需要多长时间。
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
scale-down-unready-time

string

在未读节点有资格缩减之前，应不需要多少时间
默认值为“20m”。 值必须是后跟“m”的整数。 不支持除分钟（m）以外的时间单位。
scale-down-utilization-threshold

string

节点利用率级别（定义为请求的资源之和除以容量）后，可以考虑节点进行缩减。
默认值为“0.5”。
scan-interval

string

重新评估群集以纵向扩展或缩减的频率。
默认值为“10”。 值必须是整数秒数。
skip-nodes-with-local-storage

string

如果群集自动缩放程序将跳过删除具有本地存储的 Pod 的节点，例如 EmptyDir 或 HostPath。
默认值为 true。
skip-nodes-with-system-pods

string

如果群集自动缩放程序将跳过从 kube 系统中删除具有 Pod 的节点（DaemonSet 或镜像 Pod 除外）
默认值为 true。

AzureHybridBenefit

枚举

指示是否选择加入 Azure 混合权益。 默认值为 false

值 说明
False
NotApplicable
True

CloudProviderProfile

Object

预配群集的基础云基础结构提供程序的配置文件。

名称 类型 说明
infraNetworkProfile

InfraNetworkProfile

预配群集使用的基础结构网络的配置文件

ClusterVMAccessProfile

Object

预配群集中 VM 的 SSH 受限访问配置文件。

名称 类型 说明
authorizedIPRanges

string

用于通过 SSH 访问预配群集中的 VM 的 IP 地址或 CIDR

ControlPlaneEndpoint

Object

Kubernetes API 服务器的 IP 地址

名称 类型 说明
hostIP

string

Kubernetes API 服务器的 IP 地址

ControlPlaneProfile

Object

预配群集的控制平面节点的属性

名称 类型 默认值 说明
controlPlaneEndpoint

ControlPlaneEndpoint

Kubernetes API 服务器的 IP 地址
count

integer (int32)

1

控制平面节点数。 默认值为 1，计数应为奇数
vmSize

string

控制平面节点的 VM SKU 大小

createdByType

枚举

创建资源的标识的类型。

值 说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

expander

枚举

纵向扩展时要使用的扩展器

值 说明
least-waste

选择在纵向扩展后将具有最少空闲 CPU（如果已绑定、未使用的内存）的节点组。 当你具有不同类的节点（例如，高 CPU 或高内存节点）时，这非常有用，并且仅当存在需要大量这些资源的挂起 Pod 时，才需要扩展这些节点。
most-pods

选择能够在纵向扩展时计划最多 Pod 的节点组。 使用 nodeSelector 确保某些 Pod 位于某些节点上时，这非常有用。 请注意，这不会导致自动缩放程序选择更大的节点与较小的节点，因为它可以同时添加多个较小的节点。
priority

选择具有用户分配的最高优先级的节点组。 此处 的更多详细信息介绍了配置。
random

当不需要节点组以不同的方式缩放时使用。

ExtendedLocation

Object

指向底层基础结构的扩展位置

名称 类型 说明
name

string

扩展位置的 ARM ID。
type

ExtendedLocationTypes

扩展位置类型。 允许的值：“CustomLocation”

ExtendedLocationTypes

枚举

扩展位置类型。 允许的值：“CustomLocation”

值 说明
CustomLocation

InfraNetworkProfile

Object

预配群集使用的基础结构网络的配置文件

名称 类型 说明
vnetSubnetIds

string[] (arm-id)

基础结构网络对象的 ARM 资源 ID 列表（最大为 1），例如 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}

LinuxProfileProperties

Object

预配群集的控制平面和节点池 VM 的 SSH 配置文件。

名称 类型 说明
ssh

Ssh

预配群集的 VM 的 SSH 配置。

LoadBalancerProfile

Object

HA 代理负载均衡器的配置文件。

名称 类型 默认值 说明
count

integer (int32)

0

HA 代理负载均衡器 VM 的数量。 默认值为 0。

NamedAgentPoolProfile

Object

默认代理池的配置文件以及名称参数

名称 类型 默认值 说明
count

integer (int32)

1

代理池中的节点数。 默认值为 1。
enableAutoScaling

boolean

False

是否启用自动缩放程序。 默认值为 false
kubernetesVersion

string

代理池使用的 Kubernetes 版本。 这是从预配群集的 kubernetesVersion 继承的。
maxCount

integer (int32)

自动缩放的最大节点数
maxPods

integer (int32)

可在节点上运行的 Pod 的最大数目。
minCount

integer (int32)

自动缩放的最小节点数
name

string

预配群集上下文中默认代理池的唯一名称。 默认值为 -nodepool1
nodeLabels

object

要跨代理池中的所有节点保留的节点标签。
nodeTaints

string[]

在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
osSKU

OSSKU

指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。
osType

osType

Linux

用于为 VM 指定 OS 类型的 OSType。 从 Linux 和 Windows 中进行选择。 默认为 Linux。 可能的值包括：“Linux”、“Windows”
vmSize

string

代理池节点 VM 的 VM SKU 大小。

networkPolicy

枚举

用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。

值 说明
calico

NetworkProfile

Object

预配群集的网络配置文件。

名称 类型 默认值 说明
loadBalancerProfile

LoadBalancerProfile

HA 代理负载均衡器的配置文件。
networkPolicy

networkPolicy

calico

用于生成 Kubernetes 网络的网络策略。 可能的值包括：“calico”。
podCidr

string

要从中分配 Pod IP 的 CIDR 表示法 IP 地址范围。

OSSKU

枚举

指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 CBLMariner。 OSType 为 Windows 时，默认值为 Windows2019。

值 说明
CBLMariner

将 Mariner 用作节点映像的 OS。
Windows2019

将 Windows2019 用作节点映像的 OS。
Windows2022

将 Windows2022 用作节点映像的 OS。

osType

枚举

用于为 VM 指定 OS 类型的 OSType。 从 Linux 和 Windows 中进行选择。 默认为 Linux。 可能的值包括：“Linux”、“Windows”

值 说明
Linux
Windows

provisionedCluster

Object

预配的群集资源定义。

名称 类型 说明
extendedLocation

ExtendedLocation

指向底层基础结构的扩展位置
id

string (arm-id)

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name

string

资源的名称
properties

provisionedClusterProperties

预配群集的属性。
systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ProvisionedClusterLicenseProfile

Object

预配群集的许可证配置文件。

名称 类型 默认值 说明
azureHybridBenefit

AzureHybridBenefit

NotApplicable

指示是否选择加入 Azure 混合权益。 默认值为 false

provisionedClusterProperties

Object

预配群集的属性。

名称 类型 说明
agentPoolProfiles

NamedAgentPoolProfile[]

预配群集的代理池属性。
autoScalerProfile

AutoScalerProfile

为预配的群集启用自动缩放时，要应用于群集自动缩放程序的参数。
cloudProviderProfile

CloudProviderProfile

预配群集的基础云基础结构提供程序的配置文件。
clusterVMAccessProfile

ClusterVMAccessProfile

预配群集中 VM 的 SSH 受限访问配置文件。
controlPlane

ControlPlaneProfile

预配群集的控制平面的配置文件。
kubernetesVersion

string

预配群集使用的 Kubernetes 版本。
licenseProfile

ProvisionedClusterLicenseProfile

预配群集的许可证配置文件。
linuxProfile

LinuxProfileProperties

预配群集中 Linux VM 的配置文件。
networkProfile

NetworkProfile

预配群集的网络配置文件。
provisioningState

ResourceProvisioningState

预配群集的最新长时间运行作的状态。
status

Status

已预配群集的观察状态。
storageProfile

StorageProfile

预配群集的存储配置文件。

PublicKeys

Object

用于通过 VM 进行身份验证的 SSH 公钥列表。 最多可以指定 1 个键。

名称 类型 说明
keyData

string

用于通过 SSH 向 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式（带或不带标头）。

ResourceProvisioningState

枚举

资源的预配状态

值 说明
Accepted
Canceled
Creating
Deleting
Failed
Pending
Succeeded
Updating
Upgrading

Ssh

Object

预配群集的 VM 的 SSH 配置。

名称 类型 说明
publicKeys

PublicKeys[]

用于通过 VM 进行身份验证的 SSH 公钥列表。 最多可以指定 1 个键。

Status

Object

已预配群集的观察状态。

名称 类型 说明
controlPlaneStatus

AddonStatusProfile[]

预配的群集组件（包括加载项）的详细状态。
currentState

ResourceProvisioningState

预配群集的当前状态。
errorMessage

string

在预配的群集作或稳定状态期间出现错误消息。

StorageProfile

Object

预配群集的存储配置文件。

名称 类型 说明
nfsCsiDriver

StorageProfileNfsCSIDriver

存储配置文件的 NFS CSI 驱动程序设置。
smbCsiDriver

StorageProfileSmbCSIDriver

存储配置文件的 SMB CSI 驱动程序设置。

StorageProfileNfsCSIDriver

Object

存储配置文件的 NFS CSI 驱动程序设置。

名称 类型 默认值 说明
enabled

boolean

True

指示是否启用 NFS CSI 驱动程序。 默认值为 true。

StorageProfileSmbCSIDriver

Object

存储配置文件的 SMB CSI 驱动程序设置。

名称 类型 默认值 说明
enabled

boolean

True

指示是否启用 SMB CSI 驱动程序。 默认值为 true。

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。