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

@azure/arm-hybridcontainerservice package

HybridContainerServiceClient

接口

AddonStatusProfile

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

AgentPool

agentPool 资源定义

AgentPoolCreateOrUpdateOptionalParams

可选参数。

AgentPoolDeleteHeaders

定义AgentPool_delete作的标头。

AgentPoolDeleteOptionalParams

可选参数。

AgentPoolGetOptionalParams

可选参数。

AgentPoolListByProvisionedClusterNextOptionalParams

可选参数。

AgentPoolListByProvisionedClusterOptionalParams

可选参数。

AgentPoolListResult

与预配群集关联的所有代理池资源的列表。

AgentPoolName

默认代理池的名称

AgentPoolOperations

表示 AgentPoolOperations 的接口。

AgentPoolProfile

创建期间指定的代理池属性的配置文件

AgentPoolProperties

代理池资源的属性

AgentPoolProvisioningStatus

AgentPool 资源预配状态定义

AgentPoolProvisioningStatusStatus

代理池的观察状态。

AgentPoolUpdateProfile

可更新的代理池属性的配置文件

CloudProviderProfile

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

CloudProviderProfileInfraNetworkProfile

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

ClusterVMAccessProfile

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

ControlPlaneProfile

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

ControlPlaneProfileControlPlaneEndpoint

Kubernetes API 服务器的 IP 地址

CredentialResult

凭据结果响应。

DeleteKubernetesVersionsOptionalParams

可选参数。

DeleteVMSkusOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。 (这也遵循 OData 错误响应格式)。

ExtendedLocation

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

GetKubernetesVersionsOptionalParams

可选参数。

GetVMSkusOptionalParams

可选参数。

HybridContainerServiceClientDeleteKubernetesVersionsHeaders

定义HybridContainerServiceClient_deleteKubernetesVersions作的标头。

HybridContainerServiceClientDeleteVMSkusHeaders

定义HybridContainerServiceClient_deleteVMSkus作的标头。

HybridContainerServiceClientOptionalParams

可选参数。

HybridIdentityMetadata

定义 hybridIdentityMetadata。

HybridIdentityMetadataDeleteHeaders

定义HybridIdentityMetadata_delete作的标头。

HybridIdentityMetadataDeleteOptionalParams

可选参数。

HybridIdentityMetadataGetOptionalParams

可选参数。

HybridIdentityMetadataList

hybridIdentityMetadata 列表。

HybridIdentityMetadataListByClusterNextOptionalParams

可选参数。

HybridIdentityMetadataListByClusterOptionalParams

可选参数。

HybridIdentityMetadataOperations

表示 HybridIdentityMetadataOperations 的接口。

HybridIdentityMetadataProperties

定义混合标识元数据的资源属性。

HybridIdentityMetadataPutOptionalParams

可选参数。

KubernetesPatchVersions

Kubernetes 修补程序版本配置文件

KubernetesVersionProfile

支持的 kubernetes 版本。

KubernetesVersionProfileList

支持的 kubernetes 版本列表。

KubernetesVersionProfileProperties
KubernetesVersionProperties

给定 major.minor 版本的 Kubernetes 版本配置文件

KubernetesVersionReadiness

指示 kubernetes 版本映像是否已就绪

KubernetesVersions

表示 KubernetesVersions 的接口。

KubernetesVersionsListNextOptionalParams

可选参数。

KubernetesVersionsListOptionalParams

可选参数。

LinuxProfile

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

LinuxProfileProperties

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

LinuxProfilePropertiesSsh

预配群集的 VM 的 SSH 配置。

LinuxProfilePropertiesSshPublicKeysItem
ListCredentialResponse

列表 kubeconfig 结果响应。

ListCredentialResponseError
ListCredentialResponseProperties
NamedAgentPoolProfile

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

NetworkProfile

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

NetworkProfileLoadBalancerProfile

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

Operation

从资源提供程序作 API 返回的 REST API作的详细信息

OperationDisplay

此特定作的本地化显示信息。

OperationListResult

Azure 资源提供程序支持的 REST API作列表。 它包含用于获取下一组结果的 URL 链接。

Operations

表示作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

ProvisionedCluster

预配的群集资源定义。

ProvisionedClusterInstances

表示 ProvisionedClusterInstances 的接口。

ProvisionedClusterInstancesCreateOrUpdateOptionalParams

可选参数。

ProvisionedClusterInstancesDeleteHeaders

定义ProvisionedClusterInstances_delete作的标头。

ProvisionedClusterInstancesDeleteOptionalParams

可选参数。

ProvisionedClusterInstancesGetOptionalParams

可选参数。

ProvisionedClusterInstancesGetUpgradeProfileOptionalParams

可选参数。

ProvisionedClusterInstancesListAdminKubeconfigHeaders

定义ProvisionedClusterInstances_listAdminKubeconfig作的标头。

ProvisionedClusterInstancesListAdminKubeconfigOptionalParams

可选参数。

ProvisionedClusterInstancesListNextOptionalParams

可选参数。

ProvisionedClusterInstancesListOptionalParams

可选参数。

ProvisionedClusterInstancesListUserKubeconfigHeaders

定义ProvisionedClusterInstances_listUserKubeconfig作的标头。

ProvisionedClusterInstancesListUserKubeconfigOptionalParams

可选参数。

ProvisionedClusterLicenseProfile

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

ProvisionedClusterListResult

列出与 ConnectedCluster 关联的 ProvisionedClusterInstance 资源。

ProvisionedClusterPoolUpgradeProfile

用于升级的可用 kubernetes 版本列表。

ProvisionedClusterPoolUpgradeProfileProperties

升级属性。

ProvisionedClusterProperties

预配群集的属性。

ProvisionedClusterPropertiesAutoScalerProfile

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

ProvisionedClusterPropertiesStatus

已预配群集的观察状态。

ProvisionedClusterUpgradeProfile

预配群集的可用 kubernetes 版本升级列表。

ProvisionedClusterUpgradeProfileProperties

控制平面和代理池升级配置文件。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

PutKubernetesVersionsOptionalParams

可选参数。

PutVMSkusOptionalParams

可选参数。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

StorageProfile

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

StorageProfileNfsCSIDriver

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

StorageProfileSmbCSIDriver

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

SystemData

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

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

VMSkus

表示 VMSkus 的接口。

VMSkusListNextOptionalParams

可选参数。

VMSkusListOptionalParams

可选参数。

VirtualNetwork

虚拟网络资源定义。

VirtualNetworkExtendedLocation

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

VirtualNetworkProperties

虚拟网络资源的属性

VirtualNetworkPropertiesInfraVnetProfile
VirtualNetworkPropertiesInfraVnetProfileHci

HCI 平台的基础结构网络配置文件

VirtualNetworkPropertiesStatus

虚拟网络资源的状态

VirtualNetworkPropertiesStatusOperationStatus

长时间运行的作的详细状态。

VirtualNetworkPropertiesStatusOperationStatusError

如果作中有任何错误,则为错误。

VirtualNetworkPropertiesVipPoolItem
VirtualNetworkPropertiesVmipPoolItem
VirtualNetworks

表示 VirtualNetworks 的接口。

VirtualNetworksCreateOrUpdateOptionalParams

可选参数。

VirtualNetworksDeleteHeaders

定义VirtualNetworks_delete作的标头。

VirtualNetworksDeleteOptionalParams

可选参数。

VirtualNetworksListByResourceGroupNextOptionalParams

可选参数。

VirtualNetworksListByResourceGroupOptionalParams

可选参数。

VirtualNetworksListBySubscriptionNextOptionalParams

可选参数。

VirtualNetworksListBySubscriptionOptionalParams

可选参数。

VirtualNetworksListResult

虚拟网络资源列表。

VirtualNetworksPatch

虚拟网络资源修补定义。

VirtualNetworksRetrieveOptionalParams

可选参数。

VirtualNetworksUpdateOptionalParams

可选参数。

VmSkuCapabilities

介绍 VM SKU 功能,例如 MemoryGB、vCPU 等。

VmSkuProfile

支持的 VM SKU 列表。

VmSkuProfileList

支持的 VM SKU 列表。

VmSkuProfileProperties
VmSkuProperties

支持的 VM SKU 的配置文件

类型别名

ActionType

定义 ActionType 的值。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部

AddonPhase

定义 AddonPhase 的值。
KnownAddonPhase 可与 AddonPhase 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

挂起的
预配
预配 {HelmChartInstalled}
预配 {MSICertificateDownloaded}
预配的
删除
失败
升级

AgentPoolCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

AgentPoolDeleteResponse

包含删除作的响应数据。

AgentPoolGetResponse

包含获取作的响应数据。

AgentPoolListByProvisionedClusterNextResponse

包含 listByProvisionedClusterNext作的响应数据。

AgentPoolListByProvisionedClusterResponse

包含 listByProvisionedCluster作的响应数据。

AzureHybridBenefit

定义 AzureHybridBenefit 的值。
KnownAzureHybridBenefit 可与 AzureHybridBenefit 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

True
False
NotApplicable

CreatedByType

定义 CreatedByType 的值。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
应用程序
ManagedIdentity
密钥

DeleteKubernetesVersionsResponse

包含 deleteKubernetesVersions作的响应数据。

DeleteVMSkusResponse

包含 deleteVMSkus作的响应数据。

Expander

定义 Expander 的值。
KnownExpander 可与 Expander 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

浪费最少:选择在纵向扩展后将具有最小空闲 CPU(如果已绑定、未使用的内存)的节点组。 当你具有不同类的节点(例如,高 CPU 或高内存节点)时,这非常有用,并且仅当存在需要大量这些资源的挂起 Pod 时,才需要扩展这些节点。
大多数 pod:选择在纵向扩展时能够计划最多 Pod 的节点组。 使用 nodeSelector 确保某些 Pod 位于某些节点上时,这非常有用。 请注意,这不会导致自动缩放程序选择更大的节点与较小的节点,因为它可以同时添加多个较小的节点。
优先级:选择具有用户分配的最高优先级的节点组。 此处 的更多详细信息介绍了配置。
随机:当不需要节点组以不同的方式缩放时使用。

ExtendedLocationTypes

定义 ExtendedLocationTypes 的值。
KnownExtendedLocationTypes 可与 ExtendedLocationTypes 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

CustomLocation

GetKubernetesVersionsResponse

包含 getKubernetesVersions作的响应数据。

GetVMSkusResponse

包含 getVMSkus作的响应数据。

HybridIdentityMetadataDeleteResponse

包含删除作的响应数据。

HybridIdentityMetadataGetResponse

包含获取作的响应数据。

HybridIdentityMetadataListByClusterNextResponse

包含 listByClusterNext作的响应数据。

HybridIdentityMetadataListByClusterResponse

包含 listByCluster作的响应数据。

HybridIdentityMetadataPutResponse

包含 put作的响应数据。

KubernetesVersionsListNextResponse

包含 listNext作的响应数据。

KubernetesVersionsListResponse

包含列表作的响应数据。

NetworkPolicy

定义 NetworkPolicy 的值。
KnownNetworkPolicy 可与 NetworkPolicy 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

calico

OperationsListNextResponse

包含 listNext作的响应数据。

OperationsListResponse

包含列表作的响应数据。

Origin

定义 Origin 的值。
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
系统
用户,系统

OsType

定义 OsType 的值。
KnownOsType 可与 OsType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Windows
Linux

Ossku

定义 Ossku 的值。
KnownOssku 可与 Ossku 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

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

ProvisionedClusterInstancesCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

ProvisionedClusterInstancesDeleteResponse

包含删除作的响应数据。

ProvisionedClusterInstancesGetResponse

包含获取作的响应数据。

ProvisionedClusterInstancesGetUpgradeProfileResponse

包含 getUpgradeProfile作的响应数据。

ProvisionedClusterInstancesListAdminKubeconfigResponse

包含 listAdminKubeconfig作的响应数据。

ProvisionedClusterInstancesListNextResponse

包含 listNext作的响应数据。

ProvisionedClusterInstancesListResponse

包含列表作的响应数据。

ProvisionedClusterInstancesListUserKubeconfigResponse

包含 listUserKubeconfig作的响应数据。

ProvisioningState

定义 ProvisioningState 的值。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功
失败
已取消
挂起的
创建
删除
更新
已接受

PutKubernetesVersionsResponse

包含 putKubernetesVersions作的响应数据。

PutVMSkusResponse

包含 putVMSkus作的响应数据。

ResourceProvisioningState

定义 ResourceProvisioningState 的值。
KnownResourceProvisioningState 可与 ResourceProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功
失败
已取消
挂起的
创建
删除
更新
升级
已接受

VMSkusListNextResponse

包含 listNext作的响应数据。

VMSkusListResponse

包含列表作的响应数据。

VirtualNetworksCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

VirtualNetworksDeleteResponse

包含删除作的响应数据。

VirtualNetworksListByResourceGroupNextResponse

包含 listByResourceGroupNext作的响应数据。

VirtualNetworksListByResourceGroupResponse

包含 listByResourceGroup作的响应数据。

VirtualNetworksListBySubscriptionNextResponse

包含 listBySubscriptionNext作的响应数据。

VirtualNetworksListBySubscriptionResponse

包含 listBySubscription作的响应数据。

VirtualNetworksRetrieveResponse

包含检索作的响应数据。

VirtualNetworksUpdateResponse

包含更新作的响应数据。

枚举

KnownActionType

服务的 ActionType 已知值。

KnownAddonPhase

服务的 AddonPhase 已知值。

KnownAzureHybridBenefit

AzureHybridBenefit 服务的已知值。

KnownCreatedByType

服务的 CreatedByType 的已知值

KnownExpander

服务接受的 Expander 已知值。

KnownExtendedLocationTypes

ExtendedLocationTypes 服务的已知值。

KnownNetworkPolicy

服务的 NetworkPolicy 的已知值。

KnownOrigin

服务的 Origin 的已知值

KnownOsType

服务的 OsType 的已知值。

KnownOssku

服务的 Ossku 的已知值。

KnownProvisioningState

服务的 ProvisioningState 的已知值。

KnownResourceProvisioningState

服务的 ResourceProvisioningState 的已知值。

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。