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

@azure/arm-containerservice package

ContainerServiceClient

接口

AbsoluteMonthlySchedule

对于计划,例如:“15 日每月递归”或“20 日每 3 个月递归一次”。

AdvancedNetworking

用于在群集上启用可观测性和安全功能套件的高级网络配置文件。 有关详细信息,请参阅 aka.ms/aksadvancednetworking。

AdvancedNetworkingObservability

可观测性配置文件,用于启用具有历史上下文的高级网络指标和流日志。

AdvancedNetworkingSecurity

用于在基于 cilium 的群集上启用安全功能的安全配置文件。

AgentPool

代理池。

AgentPoolAvailableVersions

代理池的可用版本列表。

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem
AgentPoolDeleteMachinesParameter

指定要删除的代理池中的计算机名称列表。

AgentPoolListResult

列表代理池操作的响应。

AgentPoolNetworkProfile

代理池的网络设置。

AgentPoolSecurityProfile

代理池的安全设置。

AgentPoolUpgradeProfile

代理池的可用升级列表。

AgentPoolUpgradeProfilePropertiesUpgradesItem
AgentPoolUpgradeSettings

用于升级代理池的设置

AgentPoolWindowsProfile

Windows 代理池的特定配置文件。

AgentPools

表示 AgentPools 的接口。

AgentPoolsAbortLatestOperationHeaders

定义AgentPools_abortLatestOperation操作的标头。

AgentPoolsAbortLatestOperationOptionalParams

可选参数。

AgentPoolsCreateOrUpdateOptionalParams

可选参数。

AgentPoolsDeleteHeaders

定义AgentPools_delete操作的标头。

AgentPoolsDeleteMachinesHeaders

定义AgentPools_deleteMachines操作的标头。

AgentPoolsDeleteMachinesOptionalParams

可选参数。

AgentPoolsDeleteOptionalParams

可选参数。

AgentPoolsGetAvailableAgentPoolVersionsOptionalParams

可选参数。

AgentPoolsGetOptionalParams

可选参数。

AgentPoolsGetUpgradeProfileOptionalParams

可选参数。

AgentPoolsListNextOptionalParams

可选参数。

AgentPoolsListOptionalParams

可选参数。

AgentPoolsUpgradeNodeImageVersionHeaders

定义AgentPools_upgradeNodeImageVersion操作的标头。

AgentPoolsUpgradeNodeImageVersionOptionalParams

可选参数。

AzureKeyVaultKms

安全配置文件的 Azure Key Vault 密钥管理服务设置。

CloudError

容器服务的错误响应。

CloudErrorBody

容器服务的错误响应。

ClusterUpgradeSettings

用于升级群集的设置。

CompatibleVersions

与服务网格修订兼容的产品/服务的版本信息。

ContainerServiceClientOptionalParams

可选参数。

ContainerServiceLinuxProfile

容器服务群集中 Linux VM 的配置文件。

ContainerServiceNetworkProfile

网络配置的配置文件。

ContainerServiceSshConfiguration

在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。

ContainerServiceSshPublicKey

包含有关 SSH 证书公钥数据的信息。

CreationData

从源资源创建目标资源时使用的数据。

CredentialResult

凭据结果响应。

CredentialResults

列表凭据结果响应。

DailySchedule

对于计划,例如:“每天递归”或“每 3 天递归一次”。

DateSpan

例如,介于“2022-12-23”和“2023-01-05”之间。

DelegatedResource

委派的资源属性 - 仅供内部使用。

EndpointDependency

AKS 代理节点正在访问的域名。

EndpointDetail

将 AKS 代理节点中的信息连接到单个终结点。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

ExtendedLocation

扩展位置的复杂类型。

IPTag

包含与对象关联的 IPTag。

IstioCertificateAuthority

Istio 服务网格证书颁发机构 (CA) 配置。 目前,我们仅支持插件证书,如此处 https://aka.ms/asm-plugin-ca

IstioComponents

Istio 组件配置。

IstioEgressGateway

Istio 出口网关配置。

IstioIngressGateway

Istio 入口网关配置。 目前,我们最多支持一个名为 aks-istio-ingressgateway-external 的外部入口网关和一个名为 aks-istio-ingressgateway-internal的内部入口网关。

IstioPluginCertificateAuthority

服务网格的插件证书信息。

IstioServiceMesh

Istio 服务网格配置。

KubeletConfig

有关详细信息,请参阅 AKS 自定义节点配置

KubernetesPatchVersion

Kubernetes 修补程序版本配置文件

KubernetesVersion

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

KubernetesVersionCapabilities

此 Kubernetes 版本的功能。

KubernetesVersionListResult

保存值属性,这是 KubernetesVersion 的数组

LinuxOSConfig

有关详细信息,请参阅 AKS 自定义节点配置

Machine

计算机。 包含有关基础虚拟机的详细信息。 计算机可能在此处可见,但在 kubectl 获取节点中不可见;如果是这样,可能是因为计算机尚未注册到 Kubernetes API 服务器。

MachineIpAddress

计算机 IP 地址详细信息。

MachineListResult

列表计算机操作的响应。

MachineNetworkProperties

计算机的网络属性

MachineProperties

计算机的属性

Machines

表示计算机的接口。

MachinesGetOptionalParams

可选参数。

MachinesListNextOptionalParams

可选参数。

MachinesListOptionalParams

可选参数。

MaintenanceConfiguration

有关计划内维护的详细信息,请参阅 计划内维护

MaintenanceConfigurationListResult

列表维护配置操作的响应。

MaintenanceConfigurations

表示 MaintenanceConfigurations 的接口。

MaintenanceConfigurationsCreateOrUpdateOptionalParams

可选参数。

MaintenanceConfigurationsDeleteOptionalParams

可选参数。

MaintenanceConfigurationsGetOptionalParams

可选参数。

MaintenanceConfigurationsListByManagedClusterNextOptionalParams

可选参数。

MaintenanceConfigurationsListByManagedClusterOptionalParams

可选参数。

MaintenanceWindow

用于为托管群集配置计划的自动升级的维护时段。

ManagedCluster

托管群集。

ManagedClusterAADProfile

有关详细信息,请参阅 AKS上的 托管 AAD。

ManagedClusterAPIServerAccessProfile

托管群集 API 服务器的访问配置文件。

ManagedClusterAccessProfile

托管群集访问配置文件。

ManagedClusterAddonProfile

托管群集的 Kubernetes 加载项配置文件。

ManagedClusterAddonProfileIdentity

此加载项使用的用户分配标识的信息。

ManagedClusterAgentPoolProfile

容器服务代理池的配置文件。

ManagedClusterAgentPoolProfileProperties

容器服务代理池配置文件的属性。

ManagedClusterAutoUpgradeProfile

托管群集的自动升级配置文件。

ManagedClusterAzureMonitorProfile

用于监视托管群集的 Azure Monitor 加载项配置文件。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 托管 Prometheus 加载项的 Kube 状态指标配置文件。 这些可选设置适用于使用加载项部署的 kube-state-metrics Pod。 有关详细信息,请参阅 aka.ms/AzureManagedPrometheus-optional-parameters。

ManagedClusterAzureMonitorProfileMetrics

适用于 Prometheus 加载项的 Azure Monitor 托管服务的指标配置文件。 收集现装的 Kubernetes 基础结构指标,以发送到 Azure Monitor 工作区,并为自定义目标配置额外的擦除。 有关概述,请参阅 aka.ms/AzureManagedPrometheus。

ManagedClusterCostAnalysis

群集的成本分析配置

ManagedClusterHttpProxyConfig

群集 HTTP 代理配置。

ManagedClusterIdentity

托管群集的标识。

ManagedClusterIngressProfile

容器服务群集的入口配置文件。

ManagedClusterIngressProfileWebAppRouting

入口配置文件的应用程序路由加载项设置。

ManagedClusterListResult

列表托管群集操作的响应。

ManagedClusterLoadBalancerProfile

托管群集负载均衡器的配置文件。

ManagedClusterLoadBalancerProfileManagedOutboundIPs

群集负载均衡器的所需托管出站 IP。

ManagedClusterLoadBalancerProfileOutboundIPPrefixes

群集负载均衡器的所需出站 IP 前缀资源。

ManagedClusterLoadBalancerProfileOutboundIPs

群集负载均衡器的所需出站 IP 资源。

ManagedClusterManagedOutboundIPProfile

托管群集的托管出站 IP 资源的配置文件。

ManagedClusterMetricsProfile

ManagedCluster 的指标配置文件。

ManagedClusterNATGatewayProfile

托管群集 NAT 网关的配置文件。

ManagedClusterNodeResourceGroupProfile

托管群集的节点资源组锁定配置文件。

ManagedClusterOidcIssuerProfile

托管群集的 OIDC 颁发者配置文件。

ManagedClusterPodIdentity

有关分配给托管群集的 Pod 标识的详细信息。

ManagedClusterPodIdentityException

有关详细信息,请参阅 禁用特定 Pod/应用程序 的 AAD Pod 标识。

ManagedClusterPodIdentityProfile

有关 Pod 标识集成的更多详细信息,请参阅 使用 AAD Pod 标识

ManagedClusterPodIdentityProvisioningError

Pod 标识预配的错误响应。

ManagedClusterPodIdentityProvisioningErrorBody

Pod 标识预配的错误响应。

ManagedClusterPodIdentityProvisioningInfo
ManagedClusterPoolUpgradeProfile

可用升级版本的列表。

ManagedClusterPoolUpgradeProfileUpgradesItem
ManagedClusterPropertiesAutoScalerProfile

启用时要应用于群集自动缩放程序的参数

ManagedClusterSKU

托管群集的 SKU。

ManagedClusterSecurityProfile

容器服务群集的安全配置文件。

ManagedClusterSecurityProfileDefender

Microsoft安全配置文件的 Defender 设置。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft安全配置文件威胁检测的 Defender 设置。

ManagedClusterSecurityProfileImageCleaner

映像清理器从节点中删除未使用的映像,释放磁盘空间并帮助减少攻击外围应用。 下面是安全配置文件的设置。

ManagedClusterSecurityProfileWorkloadIdentity

安全配置文件的工作负荷标识设置。

ManagedClusterServicePrincipalProfile

有关群集用于操作 Azure API 的服务主体标识的信息。

ManagedClusterStorageProfile

容器服务群集的存储配置文件。

ManagedClusterStorageProfileBlobCSIDriver

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

ManagedClusterStorageProfileDiskCSIDriver

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

ManagedClusterStorageProfileFileCSIDriver

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

ManagedClusterStorageProfileSnapshotController

存储配置文件的快照控制器设置。

ManagedClusterUpgradeProfile

计算池的可用升级列表。

ManagedClusterWindowsProfile

托管群集中 Windows VM 的配置文件。

ManagedClusterWorkloadAutoScalerProfile

托管群集的工作负荷自动缩放程序配置文件。

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA(Kubernetes 事件驱动的自动缩放)设置,用于工作负荷自动缩放程序配置文件。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作负荷自动缩放程序配置文件的 VPA(垂直 Pod 自动缩放程序)设置。

ManagedClusters

表示 ManagedClusters 的接口。

ManagedClustersAbortLatestOperationHeaders

定义ManagedClusters_abortLatestOperation操作的标头。

ManagedClustersAbortLatestOperationOptionalParams

可选参数。

ManagedClustersCreateOrUpdateOptionalParams

可选参数。

ManagedClustersDeleteHeaders

定义ManagedClusters_delete操作的标头。

ManagedClustersDeleteOptionalParams

可选参数。

ManagedClustersGetAccessProfileOptionalParams

可选参数。

ManagedClustersGetCommandResultHeaders

定义ManagedClusters_getCommandResult操作的标头。

ManagedClustersGetCommandResultOptionalParams

可选参数。

ManagedClustersGetMeshRevisionProfileOptionalParams

可选参数。

ManagedClustersGetMeshUpgradeProfileOptionalParams

可选参数。

ManagedClustersGetOptionalParams

可选参数。

ManagedClustersGetUpgradeProfileOptionalParams

可选参数。

ManagedClustersListByResourceGroupNextOptionalParams

可选参数。

ManagedClustersListByResourceGroupOptionalParams

可选参数。

ManagedClustersListClusterAdminCredentialsOptionalParams

可选参数。

ManagedClustersListClusterMonitoringUserCredentialsOptionalParams

可选参数。

ManagedClustersListClusterUserCredentialsOptionalParams

可选参数。

ManagedClustersListKubernetesVersionsOptionalParams

可选参数。

ManagedClustersListMeshRevisionProfilesNextOptionalParams

可选参数。

ManagedClustersListMeshRevisionProfilesOptionalParams

可选参数。

ManagedClustersListMeshUpgradeProfilesNextOptionalParams

可选参数。

ManagedClustersListMeshUpgradeProfilesOptionalParams

可选参数。

ManagedClustersListNextOptionalParams

可选参数。

ManagedClustersListOptionalParams

可选参数。

ManagedClustersListOutboundNetworkDependenciesEndpointsNextOptionalParams

可选参数。

ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams

可选参数。

ManagedClustersResetAADProfileHeaders

定义ManagedClusters_resetAADProfile操作的标头。

ManagedClustersResetAADProfileOptionalParams

可选参数。

ManagedClustersResetServicePrincipalProfileHeaders

定义ManagedClusters_resetServicePrincipalProfile操作的标头。

ManagedClustersResetServicePrincipalProfileOptionalParams

可选参数。

ManagedClustersRotateClusterCertificatesHeaders

定义ManagedClusters_rotateClusterCertificates操作的标头。

ManagedClustersRotateClusterCertificatesOptionalParams

可选参数。

ManagedClustersRotateServiceAccountSigningKeysHeaders

定义ManagedClusters_rotateServiceAccountSigningKeys操作的标头。

ManagedClustersRotateServiceAccountSigningKeysOptionalParams

可选参数。

ManagedClustersRunCommandHeaders

定义ManagedClusters_runCommand操作的标头。

ManagedClustersRunCommandOptionalParams

可选参数。

ManagedClustersStartHeaders

定义ManagedClusters_start操作的标头。

ManagedClustersStartOptionalParams

可选参数。

ManagedClustersStopHeaders

定义ManagedClusters_stop操作的标头。

ManagedClustersStopOptionalParams

可选参数。

ManagedClustersUpdateTagsOptionalParams

可选参数。

ManagedServiceIdentityUserAssignedIdentitiesValue
MeshRevision

保存有关给定 major.minor 网格版本的升级和兼容性的信息。

MeshRevisionProfile

网格的网格修订配置文件。

MeshRevisionProfileList

保存 MeshRevisionsProfiles 数组

MeshRevisionProfileProperties

网格的网格修订配置文件属性

MeshUpgradeProfile

给定网格的升级配置文件。

MeshUpgradeProfileList

保存 MeshUpgradeProfiles 数组

MeshUpgradeProfileProperties

major.minor 版本的网格升级配置文件属性。

OperationListResult

列表操作响应。

OperationValue

描述操作值的属性。

Operations

表示操作的接口。

OperationsListOptionalParams

可选参数。

OutboundEnvironmentEndpoint

AKS 代理节点连接到的出口终结点,以实现常见用途。

OutboundEnvironmentEndpointCollection

OutboundEnvironmentEndpoint 的集合

PortRange

端口范围。

PowerState

描述群集的电源状态

PrivateEndpoint

连接所属的专用终结点。

PrivateEndpointConnection

专用终结点连接

PrivateEndpointConnectionListResult

专用终结点连接列表

PrivateEndpointConnections

表示 PrivateEndpointConnections 的接口。

PrivateEndpointConnectionsDeleteOptionalParams

可选参数。

PrivateEndpointConnectionsGetOptionalParams

可选参数。

PrivateEndpointConnectionsListOptionalParams

可选参数。

PrivateEndpointConnectionsUpdateOptionalParams

可选参数。

PrivateLinkResource

专用链接资源

PrivateLinkResources

表示 PrivateLinkResources 的接口。

PrivateLinkResourcesListOptionalParams

可选参数。

PrivateLinkResourcesListResult

专用链接资源列表

PrivateLinkServiceConnectionState

专用链接服务连接的状态。

ProxyResource

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

RelativeMonthlySchedule

对于计划,例如:“在第一个星期一每月递归”或“上周五每 3 个月递归一次”。

ResolvePrivateLinkServiceId

表示 ResolvePrivateLinkServiceId 的接口。

ResolvePrivateLinkServiceIdPostOptionalParams

可选参数。

Resource

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

ResourceReference

对 Azure 资源的引用。

RunCommandRequest

运行命令请求

RunCommandResult

运行命令结果。

Schedule

应指定一种和仅一种计划类型。 为维护计划选择“daily”、“weekly”、“absoluteMonthly”或“relativeMonthly”。

ServiceMeshProfile

托管群集的服务网格配置文件。

Snapshot

节点池快照资源。

SnapshotListResult

“列表快照”操作的响应。

Snapshots

表示快照的接口。

SnapshotsCreateOrUpdateOptionalParams

可选参数。

SnapshotsDeleteOptionalParams

可选参数。

SnapshotsGetOptionalParams

可选参数。

SnapshotsListByResourceGroupNextOptionalParams

可选参数。

SnapshotsListByResourceGroupOptionalParams

可选参数。

SnapshotsListNextOptionalParams

可选参数。

SnapshotsListOptionalParams

可选参数。

SnapshotsUpdateTagsOptionalParams

可选参数。

SubResource

对另一个子资源的引用。

SysctlConfig

Linux 代理节点的 Sysctl 设置。

SystemData

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

TagsObject

用于修补操作的标记对象。

TimeInWeek

一周内的时间。

TimeSpan

例如,在 2021-05-25T13:00:00Z 和 2021-05-25T14:00:00Z 之间。

TrackedResource

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

TrustedAccessRole

受信任的访问角色定义。

TrustedAccessRoleBinding

定义资源与角色之间的绑定

TrustedAccessRoleBindingListResult

受信任的访问角色绑定列表

TrustedAccessRoleBindings

表示 TrustedAccessRoleBindings 的接口。

TrustedAccessRoleBindingsCreateOrUpdateOptionalParams

可选参数。

TrustedAccessRoleBindingsDeleteHeaders

定义TrustedAccessRoleBindings_delete操作的标头。

TrustedAccessRoleBindingsDeleteOptionalParams

可选参数。

TrustedAccessRoleBindingsGetOptionalParams

可选参数。

TrustedAccessRoleBindingsListNextOptionalParams

可选参数。

TrustedAccessRoleBindingsListOptionalParams

可选参数。

TrustedAccessRoleListResult

受信任的访问角色列表

TrustedAccessRoleRule

受信任访问角色的规则

TrustedAccessRoles

表示 TrustedAccessRoles 的接口。

TrustedAccessRolesListNextOptionalParams

可选参数。

TrustedAccessRolesListOptionalParams

可选参数。

UpgradeOverrideSettings

升级群集时替代的设置。

UserAssignedIdentity

有关用户分配标识的详细信息。

WeeklySchedule

对于计划,例如:“每周一递归”或“周三每 3 周重复一次”。

WindowsGmsaProfile

托管群集中的 Windows gMSA 配置文件。

类型别名

AgentPoolMode

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

服务支持的已知值

系统:系统代理池主要用于托管核心系统 Pod 和 metrics-server 等关键系统 Pod。 系统代理池 osType 必须是 Linux。 系统代理池 VM SKU 必须至少具有 2vCPU 和 4GB 内存。
用户:用户代理池主要用于托管应用程序 Pod。

AgentPoolType

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

服务支持的已知值

VirtualMachineScaleSets:创建虚拟机规模集支持的代理池。
AvailabilitySet:强烈建议不要使用此功能。

AgentPoolsAbortLatestOperationResponse

包含 abortLatestOperation 操作的响应数据。

AgentPoolsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

AgentPoolsDeleteMachinesResponse

包含 deleteMachines 操作的响应数据。

AgentPoolsDeleteResponse

包含删除操作的响应数据。

AgentPoolsGetAvailableAgentPoolVersionsResponse

包含 getAvailableAgentPoolVersions 操作的响应数据。

AgentPoolsGetResponse

包含获取操作的响应数据。

AgentPoolsGetUpgradeProfileResponse

包含 getUpgradeProfile 操作的响应数据。

AgentPoolsListNextResponse

包含 listNext 操作的响应数据。

AgentPoolsListResponse

包含列表操作的响应数据。

BackendPoolType

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

服务支持的已知值

NodeIPConfiguration:托管入站负载均衡器 BackendPool 的类型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.
NodeIP:托管入站负载均衡器 BackendPool 的类型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.

Code

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

服务支持的已知值

运行:群集正在运行。
已停止:群集已停止。

ConnectionStatus

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

服务支持的已知值

挂起的
已批准
拒绝
断开连接的

CreatedByType

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

服务支持的已知值

用户
应用程序
ManagedIdentity

Expander

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

服务支持的已知值

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

ExtendedLocationTypes

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

服务支持的已知值

EdgeZone

Format

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

服务支持的已知值

azure:返回 azure 身份验证提供程序 kubeconfig。 此格式在 v1.22 中已弃用,将在 v1.26 中完全删除。 请参阅:https://aka.ms/k8s/changes-1-26
exec:返回 exec 格式 kubeconfig。 此格式需要路径中的 kubelogin 二进制文件。

GPUInstanceProfile

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

服务支持的已知值

MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

IpFamily

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

服务支持的已知值

IPv4
IPv6

IstioIngressGatewayMode

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

服务支持的已知值

外部:入口网关分配有公共 IP 地址,可公开访问。
内部:入口网关分配有内部 IP 地址,不能公开访问。

KeyVaultNetworkAccessTypes

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

服务支持的已知值

公共
专用

KubeletDiskType

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

服务支持的已知值

OS:Kubelet 将对其数据使用 OS 磁盘。
临时:Kubelet 将临时磁盘用于其数据。

KubernetesSupportPlan

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

服务支持的已知值

KubernetesOfficial:对版本的支持与开源 Kubernetes 产品/服务的支持相同。 正式 Kubernetes 开源社区在发布后 1 年支持版本。
AKSLongTermSupport:对 1 年 KubernetesOfficial 支持的版本的支持。 AKS 继续修补 CVE 再 1 年,总共支持 2 年。

LicenseType

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

服务支持的已知值

:未应用其他许可。
Windows_Server:为 Windows VM 启用 Azure 混合用户权益。

LoadBalancerSku

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

服务支持的已知值

标准:使用标准负载均衡器。 这是建议的负载均衡器 SKU。 有关在托管群集中使用负载均衡器的详细信息,请参阅 标准负载均衡器 一文。
基本:使用功能有限的基本负载均衡器。

MachinesGetResponse

包含获取操作的响应数据。

MachinesListNextResponse

包含 listNext 操作的响应数据。

MachinesListResponse

包含列表操作的响应数据。

MaintenanceConfigurationsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

MaintenanceConfigurationsGetResponse

包含获取操作的响应数据。

MaintenanceConfigurationsListByManagedClusterNextResponse

包含 listByManagedClusterNext 操作的响应数据。

MaintenanceConfigurationsListByManagedClusterResponse

包含 listByManagedCluster 操作的响应数据。

ManagedClusterPodIdentityProvisioningState

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

服务支持的已知值

已分配
已取消
删除
失败
已成功
更新

ManagedClusterSKUName

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

服务支持的已知值

基本:AKS 控制平面的基本选项。

ManagedClusterSKUTier

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

服务支持的已知值

Premium:除了“标准”中包含的所有功能外,群集还具有高级功能。 高级版支持为某些 Kubernetes 版本选择 LongTermSupport (aka.ms/aks/lts)。
标准:建议用于任务关键型工作负荷和生产工作负荷。 包括 Kubernetes 控制平面自动缩放、工作负荷密集型测试,以及每个群集最多 5,000 个节点。 保证 99.95% 使用可用性区域的群集的 Kubernetes API 服务器终结点的可用性,并为不使用可用性区域的群集提供 99.9% 可用性。
免费:群集管理是免费的,但 VM、存储和网络使用情况收费。 最适合用于试验、学习、简单测试或少于 10 个节点的工作负荷。 不建议用于生产用例。

ManagedClustersAbortLatestOperationResponse

包含 abortLatestOperation 操作的响应数据。

ManagedClustersCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ManagedClustersDeleteResponse

包含删除操作的响应数据。

ManagedClustersGetAccessProfileResponse

包含 getAccessProfile 操作的响应数据。

ManagedClustersGetCommandResultResponse

包含 getCommandResult 操作的响应数据。

ManagedClustersGetMeshRevisionProfileResponse

包含 getMeshRevisionProfile 操作的响应数据。

ManagedClustersGetMeshUpgradeProfileResponse

包含 getMeshUpgradeProfile 操作的响应数据。

ManagedClustersGetResponse

包含获取操作的响应数据。

ManagedClustersGetUpgradeProfileResponse

包含 getUpgradeProfile 操作的响应数据。

ManagedClustersListByResourceGroupNextResponse

包含 listByResourceGroupNext 操作的响应数据。

ManagedClustersListByResourceGroupResponse

包含 listByResourceGroup 操作的响应数据。

ManagedClustersListClusterAdminCredentialsResponse

包含 listClusterAdminCredentials 操作的响应数据。

ManagedClustersListClusterMonitoringUserCredentialsResponse

包含 listClusterMonitoringUserCredentials 操作的响应数据。

ManagedClustersListClusterUserCredentialsResponse

包含 listClusterUserCredentials 操作的响应数据。

ManagedClustersListKubernetesVersionsResponse

包含 listKubernetesVersions 操作的响应数据。

ManagedClustersListMeshRevisionProfilesNextResponse

包含 listMeshRevisionProfilesNext 操作的响应数据。

ManagedClustersListMeshRevisionProfilesResponse

包含 listMeshRevisionProfiles 操作的响应数据。

ManagedClustersListMeshUpgradeProfilesNextResponse

包含 listMeshUpgradeProfilesNext 操作的响应数据。

ManagedClustersListMeshUpgradeProfilesResponse

包含 listMeshUpgradeProfiles 操作的响应数据。

ManagedClustersListNextResponse

包含 listNext 操作的响应数据。

ManagedClustersListOutboundNetworkDependenciesEndpointsNextResponse

包含 listOutboundNetworkDependenciesEndpointsNext 操作的响应数据。

ManagedClustersListOutboundNetworkDependenciesEndpointsResponse

包含 listOutboundNetworkDependenciesEndpoints 操作的响应数据。

ManagedClustersListResponse

包含列表操作的响应数据。

ManagedClustersRotateClusterCertificatesResponse

包含 rotateClusterCertificates 操作的响应数据。

ManagedClustersRotateServiceAccountSigningKeysResponse

包含 rotateServiceAccountSigningKeys 操作的响应数据。

ManagedClustersRunCommandResponse

包含 runCommand 操作的响应数据。

ManagedClustersStartResponse

包含启动操作的响应数据。

ManagedClustersStopResponse

包含停止操作的响应数据。

ManagedClustersUpdateTagsResponse

包含 updateTags 操作的响应数据。

NetworkDataplane

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

服务支持的已知值

azure:使用 Azure 网络数据平面。
cilium:使用 Cilium 网络数据平面。 有关详细信息,请参阅由 Cilium 提供支持的 Azure CNI

NetworkMode

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

服务支持的已知值

透明:未创建桥。 Intra-VM Pod 到 Pod 通信是通过 Azure CNI 创建的 IP 路由进行的。 有关详细信息,请参阅 透明模式
:不再支持此功能

NetworkPlugin

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

服务支持的已知值

azure:使用 Azure CNI 网络插件。 有关详细信息,请参阅 Azure CNI(高级)网络
kubenet:使用 Kubenet 网络插件。 有关详细信息,请参阅 Kubenet (基本) 网络
:未预安装 CNI 插件。 有关详细信息,请参阅 BYO CNI

NetworkPluginMode

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

服务支持的已知值

覆盖:与 networkPlugin=azure 一起使用,Pod 从 PodCIDR 地址空间获得 IP,但使用 Azure 路由域,而不是 Kubenet 路由表的方法。 有关详细信息,请访问 https://aka.ms/aks/azure-cni-overlay

NetworkPolicy

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

服务支持的已知值

:不会强制执行网络策略。 如果未指定 NetworkPolicy,则为默认值。
calico:使用 Calico 网络策略。 有关详细信息,请参阅 Azure 和 Calico 策略 之间的 差异。
azure:使用 Azure 网络策略。 有关详细信息,请参阅 Azure 和 Calico 策略
之间的 差异。
cilium:使用 Cilium 强制实施网络策略。 这要求 networkDataplane 为“cilium”。

NodeOSUpgradeChannel

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

服务支持的已知值

:不会尝试通过 OS 或滚动 VHD 更新计算机 OS。 这意味着你负责安全更新
非托管:OS 更新将通过 OS 内置修补基础结构自动应用。 新扩展的计算机最初将取消修补,并且会在某个时候由 OS 的基础结构修补。 此选项的行为取决于有问题的 OS。 Ubuntu 和 Mariner 通过无人参与的升级应用安全修补程序,大约每天大约在 06:00 UTC 一次。 Windows 不会自动应用安全修补程序,因此对于它们,此选项等效于“无”,直到进一步通知
NodeImage:AKS 将使用新修补的 VHD 更新节点,其中包含每周的安全修复和 bug 修复。 在维护时段和激增设置之后,VHD 更新计算机将滚动重新映像到该 VHD。 选择此选项作为 AKS 托管映像时,不会产生额外的 VHD 费用。
SecurityPatch:AKS 使用测试的安全更新下载和更新节点。 这些更新遵循维护时段设置,并生成新节点上使用的新 VHD。 在某些情况下,无法就地应用更新,在这种情况下,现有节点也将重新映像到新生成的 VHD,以便应用更改。 此选项在资源组中托管新的安全修补程序 VHD 会产生额外的费用,以便及时使用。

OSDiskType

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

服务支持的已知值

托管:如果 VM 需要重新定位到另一台主机,Azure 会将虚拟机的操作系统磁盘复制到 Azure 存储,以避免数据丢失。 由于容器未设计为保留本地状态,因此此行为提供有限的值,同时提供一些缺点,包括节点预配速度较慢以及读取/写入延迟较高。
临时:临时 OS 磁盘仅存储在主机上,就像临时磁盘一样。 这样可以降低读取/写入延迟,以及更快的节点缩放和群集升级。

OSType

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

服务支持的已知值

Linux:使用 Linux。
Windows:使用 Windows。

OperationsListResponse

包含列表操作的响应数据。

Ossku

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

服务支持的已知值

Ubuntu:将 Ubuntu 用作节点映像的 OS。
AzureLinux:将 AzureLinux 用作节点映像的 OS。 Azure Linux 是由 Microsoft 生成的容器优化的 Linux 发行版,有关详细信息,请访问 https://aka.ms/azurelinux
CBLMariner:弃用的 OSSKU。 Microsoft建议新部署改为选择“AzureLinux”。
Windows2019:将 Windows2019 用作节点映像的 OS。 系统节点池不支持。 Windows2019 仅支持 Windows2019 容器;它无法运行 Windows2022 容器,反之亦然。
Windows2022:将 Windows2022 用作节点映像的 OS。 系统节点池不支持。 Windows2022 仅支持 Windows2022 容器;它无法运行 Windows2019 容器,反之亦然。

OutboundType

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

服务支持的已知值

loadBalancer:负载均衡器用于通过 AKS 分配的公共 IP 出口。 这支持类型为“loadBalancer”的 Kubernetes 服务。 有关详细信息,请参阅 出站类型 loadbalancer
userDefinedRouting:出口路径必须由用户定义。 这是一个高级方案,需要适当的网络配置。 有关详细信息,请参阅 出站类型 userDefinedRouting
managedNATGateway:AKS 管理的 NAT 网关用于出口。
userAssignedNATGateway:与群集子网关联的用户分配的 NAT 网关用于出口。 这是一个高级方案,需要适当的网络配置。

PrivateEndpointConnectionProvisioningState

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

服务支持的已知值

已取消
创建
删除
失败
已成功

PrivateEndpointConnectionsGetResponse

包含获取操作的响应数据。

PrivateEndpointConnectionsListResponse

包含列表操作的响应数据。

PrivateEndpointConnectionsUpdateResponse

包含更新操作的响应数据。

PrivateLinkResourcesListResponse

包含列表操作的响应数据。

Protocol

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

服务支持的已知值

TCP:TCP 协议。
UDP:UDP 协议。

PublicNetworkAccess

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

服务支持的已知值

已启用
禁用

ResolvePrivateLinkServiceIdPostResponse

包含发布操作的响应数据。

ResourceIdentityType

定义 ResourceIdentityType 的值。

RestrictionLevel

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

服务支持的已知值

不受限制的:托管节点资源组上允许所有 RBAC 权限
ReadOnly:仅允许对托管节点资源组拥有 */read RBAC 权限

ScaleDownMode

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

服务支持的已知值

删除:在纵向扩展期间创建新实例,并在缩减期间删除实例。
解除分配:尝试在纵向扩展期间启动解除分配的实例(如果存在),并在纵向缩减期间解除分配实例。

ScaleSetEvictionPolicy

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

服务支持的已知值

删除:逐出节点池的基础规模集中的节点将被删除。
解除分配:在逐出时,节点池的基础规模集中的节点将设置为已停止解除分配的状态。 针对计算配额的已停止解除分配状态计数中的节点,并可能导致群集缩放或升级出现问题。

ScaleSetPriority

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

服务支持的已知值

现成:将使用现成优先级 VM。 没有现成节点的 SLA。 有关详细信息,请参阅 AKS 上的 位置。
常规:将使用常规 VM。

ServiceMeshMode

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

服务支持的已知值

Istio:Istio 部署为 AKS 加载项。
禁用:网格已禁用。

SnapshotType

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

服务支持的已知值

NodePool:快照是节点池的快照。

SnapshotsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

SnapshotsGetResponse

包含获取操作的响应数据。

SnapshotsListByResourceGroupNextResponse

包含 listByResourceGroupNext 操作的响应数据。

SnapshotsListByResourceGroupResponse

包含 listByResourceGroup 操作的响应数据。

SnapshotsListNextResponse

包含 listNext 操作的响应数据。

SnapshotsListResponse

包含列表操作的响应数据。

SnapshotsUpdateTagsResponse

包含 updateTags 操作的响应数据。

TrustedAccessRoleBindingProvisioningState

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

服务支持的已知值

已取消
删除
失败
已成功
更新

TrustedAccessRoleBindingsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

TrustedAccessRoleBindingsDeleteResponse

包含删除操作的响应数据。

TrustedAccessRoleBindingsGetResponse

包含获取操作的响应数据。

TrustedAccessRoleBindingsListNextResponse

包含 listNext 操作的响应数据。

TrustedAccessRoleBindingsListResponse

包含列表操作的响应数据。

TrustedAccessRolesListNextResponse

包含 listNext 操作的响应数据。

TrustedAccessRolesListResponse

包含列表操作的响应数据。

Type

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

服务支持的已知值

第一:当月的第一周。
第二:本月的第二周。
第三:当月的第三周。
第四:本月第四周。
:本月的最后一周。

UpgradeChannel

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

服务支持的已知值

快速:自动将群集升级到最新支持的次要版本上的最新受支持修补程序版本。 如果群集位于 N-2 次要版本的 Kubernetes 版本,其中 N 是最新支持的次要版本,则群集首先升级到 N-1 次要版本上支持的最新修补程序版本。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集首先升级到 1.18.6,然后升级到 1.19.1。
稳定:自动将群集升级到次要版本 N-1 上支持的最新修补程序版本,其中 N 是最新支持的次要版本。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集将升级到 1.18.6。
修补程序:在使次要版本保持相同时,自动将群集升级到最新支持的修补程序版本。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集将升级到 1.17.9。
节点映像:自动将节点映像升级到可用的最新版本。 请考虑改用 nodeOSUpgradeChannel,因为它允许配置独立于 Kubernetes 版本修补的节点 OS 修补
:禁用自动升级,并将群集保留为其当前版本的 Kubernetes。

WeekDay

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

服务支持的已知值

星期日
星期一
星期二
星期三
星期四
星期五
星期六

WorkloadRuntime

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

服务支持的已知值

OCIContainer:节点将使用 Kubelet 来运行标准 OCI 容器工作负荷。
WasmWasi:节点将使用 Krustlet 通过 WASI 提供程序(预览版)运行 WASM 工作负荷。

枚举

KnownAgentPoolMode

AgentPoolMode 服务的已知值。

KnownAgentPoolType

服务接受的 AgentPoolType 的已知值。

KnownBackendPoolType

BackendPoolType 服务的已知值。

KnownCode

服务接受的 Code 已知值。

KnownConnectionStatus

ConnectionStatus 服务的已知值。

KnownCreatedByType

服务的 CreatedByType 的已知值

KnownExpander

服务接受的 Expander 已知值。

KnownExtendedLocationTypes

ExtendedLocationTypes 服务的已知值。

KnownFormat

服务的 格式 的已知值。

KnownGPUInstanceProfile

服务的 GPUInstanceProfile 的已知值。

KnownIpFamily

IpFamily 服务的已知值。

KnownIstioIngressGatewayMode

IstioIngressGatewayMode 服务的已知值。

KnownKeyVaultNetworkAccessTypes

KeyVaultNetworkAccessTypes 服务的已知值。

KnownKubeletDiskType

KubeletDiskType 服务的已知值。

KnownKubernetesSupportPlan

服务接受的 KubernetesSupportPlan 的已知值。

KnownLicenseType

服务接受的 LicenseType 已知值。

KnownLoadBalancerSku

服务的 LoadBalancerSku 的已知值。

KnownManagedClusterPodIdentityProvisioningState

ManagedClusterPodIdentityProvisioningState 服务的已知值。

KnownManagedClusterSKUName

服务接受的 ManagedClusterSKUName 的已知值。

KnownManagedClusterSKUTier

服务的 ManagedClusterSKUTier 的已知值。

KnownNetworkDataplane

服务接受的 NetworkDataplane 的已知值。

KnownNetworkMode

服务的 NetworkMode 的已知值。

KnownNetworkPlugin

服务的 NetworkPlugin 的已知值。

KnownNetworkPluginMode

NetworkPluginMode 服务的已知值。

KnownNetworkPolicy

服务的 NetworkPolicy 的已知值。

KnownNodeOSUpgradeChannel

NodeOSUpgradeChannel 服务的已知值。

KnownOSDiskType

OSDiskType 服务的已知值。

KnownOSType

服务接受 OSType 的已知值。

KnownOssku

服务的 Ossku 的已知值。

KnownOutboundType

服务的 OutboundType 已知值。

KnownPrivateEndpointConnectionProvisioningState

PrivateEndpointConnectionProvisioningState 服务的已知值。

KnownProtocol

服务接受的 协议 的已知值。

KnownPublicNetworkAccess

PublicNetworkAccess 服务的已知值。

KnownRestrictionLevel

服务的 RestrictionLevel 已知值。

KnownScaleDownMode

ScaleDownMode 服务的已知值。

KnownScaleSetEvictionPolicy

服务接受的 ScaleSetEvictionPolicy 的已知值。

KnownScaleSetPriority

服务接受的 ScaleSetPriority 的已知值。

KnownServiceMeshMode

服务的 ServiceMeshMode 的已知值。

KnownSnapshotType

服务接受的 SnapshotType 的已知值

KnownTrustedAccessRoleBindingProvisioningState

TrustedAccessRoleBindingProvisioningState 服务的已知值。

KnownType

服务的 类型 的已知值。

KnownUpgradeChannel

服务接受的 UpgradeChannel 的已知值。

KnownWeekDay

服务的 WeekDay 已知值。

KnownWorkloadRuntime

WorkloadRuntime 服务的已知值。

函数

getContinuationToken(unknown)

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

函数详细信息

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

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

返回

string | undefined

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