你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
AgentPools interface
表示 AgentPools 的接口。
方法
方法详细信息
beginAbortLatestOperation(string, string, string, AgentPoolsAbortLatestOperationOptionalParams)
中止代理池上当前正在运行的作。 代理池将移动到“正在取消”状态，并最终在取消完成后移动到“已取消”状态。 如果在取消之前完成该作，则会返回 409 错误代码。
function beginAbortLatestOperation(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsAbortLatestOperationOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsAbortLatestOperationHeaders>, AgentPoolsAbortLatestOperationHeaders>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsAbortLatestOperationHeaders>, AgentPoolsAbortLatestOperationHeaders>>
beginAbortLatestOperationAndWait(string, string, string, AgentPoolsAbortLatestOperationOptionalParams)
中止代理池上当前正在运行的作。 代理池将移动到“正在取消”状态，并最终在取消完成后移动到“已取消”状态。 如果在取消之前完成该作，则会返回 409 错误代码。
function beginAbortLatestOperationAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsAbortLatestOperationOptionalParams): Promise<AgentPoolsAbortLatestOperationHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
选项参数。
返回
beginCreateOrUpdate(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
在指定的托管群集中创建或更新代理池。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, agentPoolName: string, parameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- parameters
- AgentPool
要创建或更新的代理池。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginCreateOrUpdateAndWait(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
在指定的托管群集中创建或更新代理池。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, parameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<AgentPool>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- parameters
- AgentPool
要创建或更新的代理池。
选项参数。
返回
Promise<AgentPool>
beginDelete(string, string, string, AgentPoolsDeleteOptionalParams)
删除指定托管群集中的代理池。
function beginDelete(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsDeleteHeaders>, AgentPoolsDeleteHeaders>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- options
- AgentPoolsDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsDeleteHeaders>, AgentPoolsDeleteHeaders>>
beginDeleteAndWait(string, string, string, AgentPoolsDeleteOptionalParams)
删除指定托管群集中的代理池。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<AgentPoolsDeleteHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- options
- AgentPoolsDeleteOptionalParams
选项参数。
返回
Promise<AgentPoolsDeleteHeaders>
beginDeleteMachines(string, string, string, AgentPoolDeleteMachinesParameter, AgentPoolsDeleteMachinesOptionalParams)
删除代理池中的特定计算机。
function beginDeleteMachines(resourceGroupName: string, resourceName: string, agentPoolName: string, machines: AgentPoolDeleteMachinesParameter, options?: AgentPoolsDeleteMachinesOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsDeleteMachinesHeaders>, AgentPoolsDeleteMachinesHeaders>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- machines
- AgentPoolDeleteMachinesParameter
要删除的代理池中的计算机列表。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsDeleteMachinesHeaders>, AgentPoolsDeleteMachinesHeaders>>
beginDeleteMachinesAndWait(string, string, string, AgentPoolDeleteMachinesParameter, AgentPoolsDeleteMachinesOptionalParams)
删除代理池中的特定计算机。
function beginDeleteMachinesAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, machines: AgentPoolDeleteMachinesParameter, options?: AgentPoolsDeleteMachinesOptionalParams): Promise<AgentPoolsDeleteMachinesHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- machines
- AgentPoolDeleteMachinesParameter
要删除的代理池中的计算机列表。
选项参数。
返回
Promise<AgentPoolsDeleteMachinesHeaders>
beginUpgradeNodeImageVersion(string, string, string, AgentPoolsUpgradeNodeImageVersionOptionalParams)
升级代理池的节点映像版本会将最新的 OS 和运行时更新应用到节点。 AKS 每周提供一个新映像，其中包含最新更新。 有关节点映像版本的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/node-image-upgrade
function beginUpgradeNodeImageVersion(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsUpgradeNodeImageVersionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginUpgradeNodeImageVersionAndWait(string, string, string, AgentPoolsUpgradeNodeImageVersionOptionalParams)
升级代理池的节点映像版本会将最新的 OS 和运行时更新应用到节点。 AKS 每周提供一个新映像，其中包含最新更新。 有关节点映像版本的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/node-image-upgrade
function beginUpgradeNodeImageVersionAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsUpgradeNodeImageVersionOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
选项参数。
返回
Promise<void>
get(string, string, string, AgentPoolsGetOptionalParams)
获取指定的托管群集代理池。
function get(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
- options
- AgentPoolsGetOptionalParams
选项参数。
返回
Promise<AgentPool>
getAvailableAgentPoolVersions(string, string, AgentPoolsGetAvailableAgentPoolVersionsOptionalParams)
有关版本生命周期的更多详细信息，请参阅 支持的 Kubernetes 版本。
function getAvailableAgentPoolVersions(resourceGroupName: string, resourceName: string, options?: AgentPoolsGetAvailableAgentPoolVersionsOptionalParams): Promise<AgentPoolAvailableVersions>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<AgentPoolAvailableVersions>
getUpgradeProfile(string, string, string, AgentPoolsGetUpgradeProfileOptionalParams)
获取代理池的升级配置文件。
function getUpgradeProfile(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsGetUpgradeProfileOptionalParams): Promise<AgentPoolUpgradeProfile>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- agentPoolName
-
string
代理池的名称。
选项参数。
返回
Promise<AgentPoolUpgradeProfile>
list(string, string, AgentPoolsListOptionalParams)
获取指定托管群集中的代理池的列表。
function list(resourceGroupName: string, resourceName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool, AgentPool[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- options
- AgentPoolsListOptionalParams
选项参数。