AgentPools interface
Interface representing a AgentPools.
Methods
| begin |
Create a new Kubernetes cluster agent pool or update the properties of the existing one. |
| begin |
Create a new Kubernetes cluster agent pool or update the properties of the existing one. |
| begin |
Delete the provided Kubernetes cluster agent pool. |
| begin |
Delete the provided Kubernetes cluster agent pool. |
| begin |
Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently. |
| begin |
Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently. |
| get(string, string, string, Agent |
Get properties of the provided Kubernetes cluster agent pool. |
| list |
Get a list of agent pools for the provided Kubernetes cluster. |
Method Details
beginCreateOrUpdate(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
Create a new Kubernetes cluster agent pool or update the properties of the existing one.
function beginCreateOrUpdate(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, agentPoolParameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- agentPoolParameters
- AgentPool
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginCreateOrUpdateAndWait(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
Create a new Kubernetes cluster agent pool or update the properties of the existing one.
function beginCreateOrUpdateAndWait(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, agentPoolParameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<AgentPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- agentPoolParameters
- AgentPool
The request body.
The options parameters.
Returns
Promise<AgentPool>
beginDelete(string, string, string, AgentPoolsDeleteOptionalParams)
Delete the provided Kubernetes cluster agent pool.
function beginDelete(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AgentPoolsDeleteOptionalParams)
Delete the provided Kubernetes cluster agent pool.
function beginDeleteAndWait(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, AgentPoolsUpdateOptionalParams)
Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.
function beginUpdate(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, options?: AgentPoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- options
- AgentPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginUpdateAndWait(string, string, string, AgentPoolsUpdateOptionalParams)
Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.
function beginUpdateAndWait(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, options?: AgentPoolsUpdateOptionalParams): Promise<AgentPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- options
- AgentPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<AgentPool>
get(string, string, string, AgentPoolsGetOptionalParams)
Get properties of the provided Kubernetes cluster agent pool.
function get(resourceGroupName: string, kubernetesClusterName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
- agentPoolName
-
string
The name of the Kubernetes cluster agent pool.
- options
- AgentPoolsGetOptionalParams
The options parameters.
Returns
Promise<AgentPool>
listByKubernetesCluster(string, string, AgentPoolsListByKubernetesClusterOptionalParams)
Get a list of agent pools for the provided Kubernetes cluster.
function listByKubernetesCluster(resourceGroupName: string, kubernetesClusterName: string, options?: AgentPoolsListByKubernetesClusterOptionalParams): PagedAsyncIterableIterator<AgentPool, AgentPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- kubernetesClusterName
-
string
The name of the Kubernetes cluster.
The options parameters.