AgentPools interface
AgentPools を表すインターフェイス。
メソッド
メソッドの詳細
beginAbortLatestOperation(string, string, string, AgentPoolsAbortLatestOperationOptionalParams)
エージェント プールで現在実行中の操作を中止します。 エージェント プールは取り消し中の状態に移動され、取り消しが完了すると最終的に取り消された状態になります。 取り消しが行われる前に操作が完了すると、エラーが返されます。
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)
エージェント プールで現在実行中の操作を中止します。 エージェント プールは取り消し中の状態に移動され、取り消しが完了すると最終的に取り消された状態になります。 取り消しが行われる前に操作が完了すると、エラーが返されます。
function beginAbortLatestOperationAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsAbortLatestOperationOptionalParams): Promise<AgentPoolsAbortLatestOperationHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
マネージド クラスター リソースの名前。
- agentPoolName
-
string
エージェント プールの名前。
オプション パラメーター。
戻り値
beginCompleteUpgrade(string, string, string, AgentPoolsCompleteUpgradeOptionalParams)
指定したエージェント プールのアップグレード操作を完了します。
function beginCompleteUpgrade(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsCompleteUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsCompleteUpgradeHeaders>, AgentPoolsCompleteUpgradeHeaders>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
マネージド クラスター リソースの名前。
- agentPoolName
-
string
エージェント プールの名前。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsCompleteUpgradeHeaders>, AgentPoolsCompleteUpgradeHeaders>>
beginCompleteUpgradeAndWait(string, string, string, AgentPoolsCompleteUpgradeOptionalParams)
指定したエージェント プールのアップグレード操作を完了します。
function beginCompleteUpgradeAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsCompleteUpgradeOptionalParams): Promise<AgentPoolsCompleteUpgradeHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
マネージド クラスター リソースの名前。
- agentPoolName
-
string
エージェント プールの名前。
オプション パラメーター。
戻り値
Promise<AgentPoolsCompleteUpgradeHeaders>
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 では、1 週間に 1 つの新しいイメージと最新の更新プログラムが提供されます。 ノード イメージのバージョンの詳細については、次を参照してください: 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 では、1 週間に 1 つの新しいイメージと最新の更新プログラムが提供されます。 ノード イメージのバージョンの詳細については、次を参照してください: 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
オプション パラメーター。
