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

@azure/arm-containerservicefleet package

ContainerServiceFleetClient

接口

APIServerAccessProfile

舰队中心 API 服务器的访问配置文件。

AgentProfile

舰队中心的代理配置文件。

ContainerServiceFleetClientOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

Fleet

舰队资源。

FleetCredentialResult

一个凭据结果项。

FleetCredentialResults

凭据结果响应。

FleetHubProfile

FleetHubProfile 配置舰队中心。

FleetListResult

舰队列表操作的响应。

FleetMember

舰队的成员。 它包含对 Azure 上现有 Kubernetes 群集的引用。

FleetMemberListResult

FleetMember 列表操作的响应。

FleetMemberUpdate

用于 FleetMember 更新操作的类型。

FleetMembers

表示 FleetMembers 的接口。

FleetMembersCreateHeaders

定义FleetMembers_create操作的标头。

FleetMembersCreateOptionalParams

可选参数。

FleetMembersDeleteHeaders

定义FleetMembers_delete操作的标头。

FleetMembersDeleteOptionalParams

可选参数。

FleetMembersGetOptionalParams

可选参数。

FleetMembersListByFleetNextOptionalParams

可选参数。

FleetMembersListByFleetOptionalParams

可选参数。

FleetMembersUpdateHeaders

定义FleetMembers_update操作的标头。

FleetMembersUpdateOptionalParams

可选参数。

FleetPatch

可以修补的舰队的属性。

FleetUpdateStrategies

表示 FleetUpdateStrategies 的接口。

FleetUpdateStrategiesCreateOrUpdateHeaders

定义FleetUpdateStrategies_createOrUpdate操作的标头。

FleetUpdateStrategiesCreateOrUpdateOptionalParams

可选参数。

FleetUpdateStrategiesDeleteHeaders

定义FleetUpdateStrategies_delete操作的标头。

FleetUpdateStrategiesDeleteOptionalParams

可选参数。

FleetUpdateStrategiesGetOptionalParams

可选参数。

FleetUpdateStrategiesListByFleetNextOptionalParams

可选参数。

FleetUpdateStrategiesListByFleetOptionalParams

可选参数。

FleetUpdateStrategy

定义跨舰队成员执行更新操作的多阶段过程。

FleetUpdateStrategyListResult

FleetUpdateStrategy list 操作的响应。

Fleets

表示舰队的接口。

FleetsCreateOrUpdateHeaders

定义Fleets_createOrUpdate操作的标头。

FleetsCreateOrUpdateOptionalParams

可选参数。

FleetsDeleteHeaders

定义Fleets_delete操作的标头。

FleetsDeleteOptionalParams

可选参数。

FleetsGetOptionalParams

可选参数。

FleetsListByResourceGroupNextOptionalParams

可选参数。

FleetsListByResourceGroupOptionalParams

可选参数。

FleetsListBySubscriptionNextOptionalParams

可选参数。

FleetsListBySubscriptionOptionalParams

可选参数。

FleetsListCredentialsOptionalParams

可选参数。

FleetsUpdateHeaders

定义Fleets_update操作的标头。

FleetsUpdateOptionalParams

可选参数。

ManagedClusterUpdate

要应用于 ManagedCluster 的更新。

ManagedClusterUpgradeSpec

要应用于 ManagedCluster 的升级。

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

MemberUpdateStatus

成员更新操作的状态。

NodeImageSelection

要应用于更新运行中目标节点的节点映像升级。

NodeImageSelectionStatus

更新运行的节点映像升级规范。

NodeImageVersion

节点升级映像版本。

Operation

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

OperationDisplay

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

OperationListResult

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

Operations

表示操作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

ProxyResource

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

Resource

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

SkipProperties

包含多个跳过请求的跳过操作的属性。

SkipTarget

单个跳过请求的定义。

SystemData

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

TrackedResource

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

UpdateGroup

要更新的组。

UpdateGroupStatus

UpdateGroup 的状态。

UpdateRun

跨舰队成员执行更新操作的多阶段过程。

UpdateRunListResult

UpdateRun 列表操作的响应。

UpdateRunStatus

UpdateRun 的状态。

UpdateRunStrategy

通过阶段和组定义群集的更新顺序。

运行中的阶段按顺序依次执行。 阶段中的组并行执行。 组中的成员群集将依次更新。

有效的策略在阶段内或跨阶段不包含重复的组。

UpdateRuns

表示 UpdateRuns 的接口。

UpdateRunsCreateOrUpdateHeaders

定义UpdateRuns_createOrUpdate操作的标头。

UpdateRunsCreateOrUpdateOptionalParams

可选参数。

UpdateRunsDeleteHeaders

定义UpdateRuns_delete操作的标头。

UpdateRunsDeleteOptionalParams

可选参数。

UpdateRunsGetOptionalParams

可选参数。

UpdateRunsListByFleetNextOptionalParams

可选参数。

UpdateRunsListByFleetOptionalParams

可选参数。

UpdateRunsSkipHeaders

定义UpdateRuns_skip操作的标头。

UpdateRunsSkipOptionalParams

可选参数。

UpdateRunsStartHeaders

定义UpdateRuns_start操作的标头。

UpdateRunsStartOptionalParams

可选参数。

UpdateRunsStopHeaders

定义UpdateRuns_stop操作的标头。

UpdateRunsStopOptionalParams

可选参数。

UpdateStage

定义一个阶段,其中包含要更新的组和要采取 (的步骤,例如,在开始下一阶段之前等待一段时间) 。

UpdateStageStatus

UpdateStage 的状态。

UpdateStatus

操作或操作组的状态。

UserAssignedIdentity

用户分配的标识属性

WaitStatus

等待持续时间的状态。

类型别名

ActionType

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

服务支持的已知值

内部

CreatedByType

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

服务支持的已知值

用户
应用程序
ManagedIdentity

FleetMemberProvisioningState

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

服务支持的已知值

成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。
正在加入:加入队列的成员的预配状态。
离开:离开舰队的成员的预配状态。
正在更新:正在更新的成员的预配状态。

FleetMembersCreateResponse

包含创建操作的响应数据。

FleetMembersGetResponse

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

FleetMembersListByFleetNextResponse

包含 listByFleetNext 操作的响应数据。

FleetMembersListByFleetResponse

包含 listByFleet 操作的响应数据。

FleetMembersUpdateResponse

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

FleetProvisioningState

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

服务支持的已知值

成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。
正在创建:正在创建的机群的预配状态。
正在更新:正在更新的机群的预配状态。
正在删除:正在删除的机群的预配状态。

FleetUpdateStrategiesCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

FleetUpdateStrategiesGetResponse

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

FleetUpdateStrategiesListByFleetNextResponse

包含 listByFleetNext 操作的响应数据。

FleetUpdateStrategiesListByFleetResponse

包含 listByFleet 操作的响应数据。

FleetUpdateStrategyProvisioningState

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

服务支持的已知值

成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。

FleetsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

FleetsGetResponse

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

FleetsListByResourceGroupNextResponse

包含 listByResourceGroupNext 操作的响应数据。

FleetsListByResourceGroupResponse

包含 listByResourceGroup 操作的响应数据。

FleetsListBySubscriptionNextResponse

包含 listBySubscriptionNext 操作的响应数据。

FleetsListBySubscriptionResponse

包含 listBySubscription 操作的响应数据。

FleetsListCredentialsResponse

包含 listCredentials 操作的响应数据。

FleetsUpdateResponse

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

ManagedClusterUpgradeType

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

服务支持的已知值

Full:完全升级目标 ManagedClusters 的控制平面和所有代理池。 需要设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。
NodeImageOnly:NodeImageOnly 仅升级目标 ManagedCluster 的节点映像。 要求不设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。
ControlPlaneOnly:ControlPlaneOnly 升级仅面向 ManagedClusters 的 KubernetesVersion,不会应用于 AgentPool。 需要设置 ManagedClusterUpgradeSpec.KubernetesVersion 属性。

ManagedServiceIdentityType

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

服务支持的已知值


SystemAssigned
UserAssigned
SystemAssigned、UserAssigned

NodeImageSelectionType

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

服务支持的已知值

最新:升级节点时使用最新的映像版本。 群集可能使用不同的映像版本 (,例如,“AKSUbuntu-1804gen2containerd-2021.10.12”和“AKSUbuntu-1804gen2containerd-2021.10.19”) ,例如,不同区域中的最新可用版本不同。
一致:选择要将节点升级到的映像版本,如下所述:对于受更新运行影响的托管群集中的每个节点池,系统会选择最新的映像版本,以便在所有其他节点池 (在相同映像类型) 的所有其他群集中可用。 因此,同一映像类型的所有节点池都将升级到相同的映像版本。 例如,如果群集 A 区域 X 中的节点池的映像类型“AKSUbuntu-1804gen2containerd”的最新映像版本为“AKSUbuntu-1804gen2containerd-2021.10.12” , 对于区域 Y 中群集 B 中的节点池,为“AKSUbuntu-1804gen2containerd-2021.10.17”,系统将这两个节点池升级到映像版本“AKSUbuntu-1804gen2containerd-2021.10.12”。

OperationsListNextResponse

包含 listNext 操作的响应数据。

OperationsListResponse

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

Origin

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

服务支持的已知值

user
系统
user,system

TargetType

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

服务支持的已知值

成员:跳过成员的更新。
:跳过组的更新。
阶段:跳过整个阶段的更新,包括后阶段等待。
AfterStageWait:跳过某个阶段的后阶段等待的更新。

UpdateRunProvisioningState

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

服务支持的已知值

成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。

UpdateRunsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

UpdateRunsGetResponse

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

UpdateRunsListByFleetNextResponse

包含 listByFleetNext 操作的响应数据。

UpdateRunsListByFleetResponse

包含 listByFleet 操作的响应数据。

UpdateRunsSkipResponse

包含跳过操作的响应数据。

UpdateRunsStartResponse

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

UpdateRunsStopResponse

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

UpdateState

定义 UpdateState 的值。
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 的状态。

枚举

KnownActionType

服务接受的 ActionType 的已知值。

KnownCreatedByType

服务接受的 CreatedByType 的已知值。

KnownFleetMemberProvisioningState

服务接受的 FleetMemberProvisioningState 的已知值。

KnownFleetProvisioningState

服务接受的 FleetProvisioningState 的已知值。

KnownFleetUpdateStrategyProvisioningState

服务接受的 FleetUpdateStrategyProvisioningState 的已知值。

KnownManagedClusterUpgradeType

服务接受的 ManagedClusterUpgradeType 的已知值。

KnownManagedServiceIdentityType

服务接受的 ManagedServiceIdentityType 的已知值。

KnownNodeImageSelectionType

服务接受的 NodeImageSelectionType 的已知值。

KnownOrigin

服务接受的 Origin 的已知值。

KnownTargetType

服务接受的 TargetType 的已知值。

KnownUpdateRunProvisioningState

服务接受的 UpdateRunProvisioningState 的已知值。

KnownUpdateState

服务接受的 UpdateState 的已知值。

函数

getContinuationToken(unknown)

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

函数详细信息

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

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

返回

string | undefined

可在将来调用期间传入 byPage () 的继续标记。