@azure/arm-containerservicefleet package

类

ContainerServiceFleetClient

接口

APIServerAccessProfile	机队中心 API 服务器的访问配置文件。
AgentProfile	舰队中心的代理配置文件。
AutoUpgradeNodeImageSelection	要应用于自动升级中目标群集的节点映像升级。
AutoUpgradeProfile	AutoUpgradeProfile 资源。
AutoUpgradeProfileOperationsGenerateUpdateRunOptionalParams	可选参数。
AutoUpgradeProfileOperationsOperations	表示 AutoUpgradeProfileOperations作的接口。
AutoUpgradeProfileProperties	AutoUpgradeProfile 的属性。
AutoUpgradeProfileStatus	AutoUpgradeProfileStatus 是自动升级配置文件的状态。
AutoUpgradeProfilesCreateOrUpdateOptionalParams	可选参数。
AutoUpgradeProfilesDeleteOptionalParams	可选参数。
AutoUpgradeProfilesGetOptionalParams	可选参数。
AutoUpgradeProfilesListByFleetOptionalParams	可选参数。
AutoUpgradeProfilesOperations	表示 AutoUpgradeProfiles作的接口。
ContainerServiceFleetClientOptionalParams	客户端的可选参数。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败作的错误详细信息。
Fleet	舰队资源。
FleetCredentialResult	一个凭据结果项。
FleetCredentialResults	凭据结果响应。
FleetHubProfile	FleetHubProfile 配置机群中心。
FleetMember	舰队的成员。 它包含对 Azure 上现有 Kubernetes 群集的引用。
FleetMemberProperties	舰队的成员。 它包含对 Azure 上现有 Kubernetes 群集的引用。
FleetMemberStatus	机队成员的状态信息
FleetMemberUpdate	用于 FleetMember 更新作的类型。
FleetMemberUpdateProperties	FleetMember 的可更新属性。
FleetMembersCreateOptionalParams	可选参数。
FleetMembersDeleteOptionalParams	可选参数。
FleetMembersGetOptionalParams	可选参数。
FleetMembersListByFleetOptionalParams	可选参数。
FleetMembersOperations	表示 FleetMembers作的接口。
FleetMembersUpdateAsyncOptionalParams	可选参数。
FleetPatch	可以修补的机队的属性。
FleetProperties	Fleet 属性。
FleetStatus	机队的状态信息。
FleetUpdateStrategiesCreateOrUpdateOptionalParams	可选参数。
FleetUpdateStrategiesDeleteOptionalParams	可选参数。
FleetUpdateStrategiesGetOptionalParams	可选参数。
FleetUpdateStrategiesListByFleetOptionalParams	可选参数。
FleetUpdateStrategiesOperations	表示 FleetUpdateStrategies作的接口。
FleetUpdateStrategy	定义多阶段过程，以跨机队成员执行更新作。
FleetUpdateStrategyProperties	UpdateStrategy 的属性。
FleetsCreateOptionalParams	可选参数。
FleetsDeleteOptionalParams	可选参数。
FleetsGetOptionalParams	可选参数。
FleetsListByResourceGroupOptionalParams	可选参数。
FleetsListBySubscriptionOptionalParams	可选参数。
FleetsListCredentialsOptionalParams	可选参数。
FleetsOperations	表示机队操作的接口。
FleetsUpdateAsyncOptionalParams	可选参数。
GenerateResponse	GenerateResponse 是生成请求的响应。
ManagedClusterUpdate	要应用于 ManagedClusters 的更新。
ManagedClusterUpgradeSpec	要应用于 ManagedCluster 的升级。
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
MemberUpdateStatus	成员更新作的状态。
NodeImageSelection	要应用于更新运行中目标节点的节点映像升级。
NodeImageSelectionStatus	更新运行的节点映像升级规范。
NodeImageVersion	节点升级映像版本。
Operation	从资源提供程序作 API 返回的 REST API作的详细信息
OperationDisplay	本地化的显示信息和作。
OperationsListOptionalParams	可选参数。
OperationsOperations	表示作作的接口。
PageSettings	byPage 方法的选项
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
RestorePollerOptions
SkipProperties	包含多个跳过请求的跳过作的属性。
SkipTarget	单个跳过请求的定义。
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
UpdateGroup	要更新的组。
UpdateGroupStatus	UpdateGroup 的状态。
UpdateRun	跨机队成员执行更新作的多阶段过程。
UpdateRunProperties	UpdateRun 的属性。
UpdateRunStatus	UpdateRun 的状态。
UpdateRunStrategy	通过阶段和组定义群集的更新序列。 运行中的阶段依次执行。 阶段中的组并行执行。 组中的成员群集会依次更新。 有效的策略在阶段内或跨阶段不包含重复组。
UpdateRunsCreateOrUpdateOptionalParams	可选参数。
UpdateRunsDeleteOptionalParams	可选参数。
UpdateRunsGetOptionalParams	可选参数。
UpdateRunsListByFleetOptionalParams	可选参数。
UpdateRunsOperations	表示 UpdateRuns作的接口。
UpdateRunsSkipOptionalParams	可选参数。
UpdateRunsStartOptionalParams	可选参数。
UpdateRunsStopOptionalParams	可选参数。
UpdateStage	定义一个阶段，其中包含要更新的组以及执行的步骤（例如，等待一段时间），然后再开始下一阶段。
UpdateStageStatus	UpdateStage 的状态。
UpdateStatus	作或作组的状态。
UserAssignedIdentity	用户分配的标识属性
WaitStatus	等待持续时间的状态。

类型别名

ActionType	可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 内部：作适用于仅限内部的 API。
AutoUpgradeLastTriggerStatus	AutoUpgradeLastTriggerStatus 是上次 AutoUpgrade 触发器的状态（尝试在有新版本发布新版本时自动创建和启动 UpdateRun）。 KnownAutoUpgradeLastTriggerStatus 可与 AutoUpgradeLastTriggerStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Succeeded：最后一个 AutoUpgrade 触发器已成功。 Failed：最后一个 AutoUpgrade 触发器失败。
AutoUpgradeNodeImageSelectionType	节点映像升级类型。 KnownAutoUpgradeNodeImageSelectionType 可以与 AutoUpgradeNodeImageSelectionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 最新：升级节点时使用最新的映像版本。 群集可能使用不同的映像版本（例如，“AKSUbuntu-1804gen2containerd-2021.10.12”和“AKSUbuntu-1804gen2containerd-2021.10.19”），例如，不同区域中的最新可用版本不同。 一致：要升级节点的映像版本，如下所示：对于受更新运行影响的托管群集中的每个节点池，系统会选择最新的映像版本，以便在相同映像类型的所有其他节点池（所有其他群集）中可用。 因此，同一映像类型的所有节点池都将升级到同一映像版本。 例如，如果映像类型“AKSUbuntu-1804gen2containerd”的最新映像版本是区域 X 中群集 A 中的节点池的“AKSUbuntu-1804gen2containerd-2021.10.12” 并且是区域 Y 中群集 B 中的节点池的“AKSUbuntu-1804gen2containerd-2021.10.17”，系统将这两个节点池升级到映像版本“AKSUbuntu-1804gen2containerd-2021.10.12”。
AutoUpgradeProfileProvisioningState	AutoUpgradeProfile 资源的预配状态。 KnownAutoUpgradeProfileProvisioningState 可与 AutoUpgradeProfileProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。
ContinuablePage	描述结果页的接口。
CreatedByType	创建资源的实体类型。 <xref:KnowncreatedByType> 可与 createdByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：实体是由用户创建的。 应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。 密钥：实体是由密钥创建的。
FleetMemberProvisioningState	上次接受操作的预配状态。 KnownFleetMemberProvisioningState 可与 FleetMemberProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。 加入：加入车队的成员的预配状态。 离开：离开车队的成员的预配状态。 更新：正在更新的成员的预配状态。
FleetProvisioningState	上次接受操作的预配状态。 KnownFleetProvisioningState 可与 FleetProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。 创建：正在创建的车队的预配状态。 更新：正在更新的机队的预配状态。 删除：正在删除的机群的预配状态。
FleetUpdateStrategyProvisioningState	UpdateStrategy 资源的预配状态。 KnownFleetUpdateStrategyProvisioningState 可与 FleetUpdateStrategyProvisioningState 互换，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。
ManagedClusterUpgradeType	针对 ManagedClusters 时要执行的升级类型。 KnownManagedClusterUpgradeType 可与 ManagedClusterUpgradeType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 完整：完全升级目标 ManagedClusters 的控制平面和所有代理池。 需要设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。 NodeImageOnly：NodeImageOnly 仅升级目标 ManagedClusters 的节点映像。 要求不设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。 ControlPlaneOnly：ControlPlaneOnly 升级仅面向 ManagedClusters 的 KubernetesVersion，不会应用于 AgentPool。 需要设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无：无托管标识。 SystemAssigned：系统分配的托管标识。 UserAssigned：用户分配的托管标识。 SystemAssigned、UserAssigned：系统和用户分配的托管标识。
NodeImageSelectionType	节点映像升级类型。 KnownNodeImageSelectionType 可与 NodeImageSelectionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 最新：升级节点时使用最新的映像版本。 群集可能使用不同的映像版本（例如，“AKSUbuntu-1804gen2containerd-2021.10.12”和“AKSUbuntu-1804gen2containerd-2021.10.19”），例如，不同区域中的最新可用版本不同。 一致：要升级节点的映像版本，如下所示：对于受更新运行影响的托管群集中的每个节点池，系统会选择最新的映像版本，以便在相同映像类型的所有其他节点池（所有其他群集）中可用。 因此，同一映像类型的所有节点池都将升级到同一映像版本。 例如，如果映像类型“AKSUbuntu-1804gen2containerd”的最新映像版本是区域 X 中群集 A 中的节点池的“AKSUbuntu-1804gen2containerd-2021.10.12” 并且是区域 Y 中群集 B 中的节点池的“AKSUbuntu-1804gen2containerd-2021.10.17”，系统将这两个节点池升级到映像版本“AKSUbuntu-1804gen2containerd-2021.10.12”。 自定义：将节点升级到自定义镜像版本。 设置后，更新运行将使用 customNodeImageVersions 中提供的节点映像版本来升级节点。 如果已设置，则 customNodeImageVersions 不得为空。
Origin	操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system” KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：指示作是由用户启动的。 系统：指示作是由系统启动的。 用户，系统：指示作是由用户或系统启动的。
TargetType	跳过请求的目标类型。 KnownTargetType 可与 TargetType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成员：跳过成员的更新。 组：跳过组的更新。 阶段：跳过整个阶段的更新，包括阶段后等待。 AfterStageWait：跳过阶段后等待某个阶段的更新。
UpdateRunProvisioningState	UpdateRun 资源的预配状态。 KnownUpdateRunProvisioningState 可与 UpdateRunProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。
UpdateState	UpdateRun、UpdateStage、UpdateGroup 或 MemberUpdate 的状态。 KnownUpdateState 可与 UpdateState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 NotStarted：尚未启动的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 运行：正在运行的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 停止：正在停止的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 已停止：已停止的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 跳过：已跳过的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 失败：已失败的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。 已完成：已完成的 UpdateRun/UpdateStage/UpdateGroup/MemberUpdate 的状态。
UpgradeChannel	配置如何运行自动升级。 KnownUpgradeChannel 可与 UpgradeChannel 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 稳定：将集群 kubernetes 版本升级到次要版本 N-1 上支持的最新补丁版本，其中 N 是最新支持的次要版本。 例如，如果群集运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1，则群集升级到 1.18.6。 快速：在最新支持的次要版本上将集群 kubernetes 版本升级到最新支持的补丁版本。 NodeImage：升级集群的节点镜像版本。

枚举

KnownActionType	可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownAutoUpgradeLastTriggerStatus	AutoUpgradeLastTriggerStatus 是上次 AutoUpgrade 触发器的状态（尝试在有新版本发布新版本时自动创建和启动 UpdateRun）。
KnownAutoUpgradeNodeImageSelectionType	节点映像升级类型。
KnownAutoUpgradeProfileProvisioningState	AutoUpgradeProfile 资源的预配状态。
KnownCreatedByType	创建资源的实体类型。
KnownFleetMemberProvisioningState	上次接受操作的预配状态。
KnownFleetProvisioningState	上次接受操作的预配状态。
KnownFleetUpdateStrategyProvisioningState	UpdateStrategy 资源的预配状态。
KnownManagedClusterUpgradeType	针对 ManagedClusters 时要执行的升级类型。
KnownManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
KnownNodeImageSelectionType	节点映像升级类型。
KnownOrigin	操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system”
KnownTargetType	跳过请求的目标类型。
KnownUpdateRunProvisioningState	UpdateRun 资源的预配状态。
KnownUpdateState	UpdateRun、UpdateStage、UpdateGroup 或 MemberUpdate 的状态。
KnownUpgradeChannel	配置如何运行自动升级。
KnownVersions	Azure Kubernetes Fleet Manager API 版本。

函数

restorePoller<TResponse, TResult>(ContainerServiceFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

函数详细信息

restorePoller<TResponse, TResult>(ContainerServiceFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

function restorePoller<TResponse, TResult>(client: ContainerServiceFleetClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

client

ContainerServiceFleetClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

返回

PollerLike<OperationState<TResult>, TResult>