AgentPoolsClient Interface

public interface AgentPoolsClient

An instance of this class provides access to all the operations defined in AgentPoolsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginCreateOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters)

Create or update the Kubernetes cluster agent pool.

abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginCreateOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the Kubernetes cluster agent pool.

abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Delete the Kubernetes cluster agent pool.

abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster agent pool.

abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Patch the Kubernetes cluster agent pool.

abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, AgentPoolPatchParameters agentPoolUpdateParameters, Context context)

Patch the Kubernetes cluster agent pool.

abstract AgentPoolInner createOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters)

Create or update the Kubernetes cluster agent pool.

abstract AgentPoolInner createOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the Kubernetes cluster agent pool.

abstract OperationStatusResultInner delete(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Delete the Kubernetes cluster agent pool.

abstract OperationStatusResultInner delete(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster agent pool.

abstract AgentPoolInner get(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Retrieve the Kubernetes cluster agent pool.

abstract Response<AgentPoolInner> getWithResponse(String resourceGroupName, String kubernetesClusterName, String agentPoolName, Context context)

Retrieve the Kubernetes cluster agent pool.

abstract PagedIterable<AgentPoolInner> listByKubernetesCluster(String resourceGroupName, String kubernetesClusterName)

List agent pools of the Kubernetes cluster.

abstract PagedIterable<AgentPoolInner> listByKubernetesCluster(String resourceGroupName, String kubernetesClusterName, Integer top, String skipToken, Context context)

List agent pools of the Kubernetes cluster.

abstract AgentPoolInner update(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Patch the Kubernetes cluster agent pool.

abstract AgentPoolInner update(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, AgentPoolPatchParameters agentPoolUpdateParameters, Context context)

Patch the Kubernetes cluster agent pool.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginCreateOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters)

Create or update the Kubernetes cluster agent pool. Create a new Kubernetes cluster agent pool or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
agentPoolParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of agentPool represents the agent pool of Kubernetes cluster.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginCreateOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the Kubernetes cluster agent pool. Create a new Kubernetes cluster agent pool or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
agentPoolParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of agentPool represents the agent pool of Kubernetes cluster.

beginDelete

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Delete the Kubernetes cluster agent pool. Delete the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginDelete

public abstract SyncPoller<PollResult<OperationStatusResultInner>,OperationStatusResultInner> beginDelete(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster agent pool. Delete the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the current status of an async operation.

beginUpdate

public abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Patch the Kubernetes cluster agent pool. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.

Returns:

the SyncPoller<T,U> for polling of agentPool represents the agent pool of Kubernetes cluster.

beginUpdate

public abstract SyncPoller<PollResult<AgentPoolInner>,AgentPoolInner> beginUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, AgentPoolPatchParameters agentPoolUpdateParameters, Context context)

Patch the Kubernetes cluster agent pool. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
agentPoolUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of agentPool represents the agent pool of Kubernetes cluster.

createOrUpdate

public abstract AgentPoolInner createOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters)

Create or update the Kubernetes cluster agent pool. Create a new Kubernetes cluster agent pool or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
agentPoolParameters - The request body.

Returns:

agentPool represents the agent pool of Kubernetes cluster.

createOrUpdate

public abstract AgentPoolInner createOrUpdate(String resourceGroupName, String kubernetesClusterName, String agentPoolName, AgentPoolInner agentPoolParameters, String ifMatch, String ifNoneMatch, Context context)

Create or update the Kubernetes cluster agent pool. Create a new Kubernetes cluster agent pool or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
agentPoolParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

agentPool represents the agent pool of Kubernetes cluster.

delete

public abstract OperationStatusResultInner delete(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Delete the Kubernetes cluster agent pool. Delete the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.

Returns:

the current status of an async operation.

delete

public abstract OperationStatusResultInner delete(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, Context context)

Delete the Kubernetes cluster agent pool. Delete the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

get

public abstract AgentPoolInner get(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Retrieve the Kubernetes cluster agent pool. Get properties of the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.

Returns:

properties of the provided Kubernetes cluster agent pool.

getWithResponse

public abstract Response<AgentPoolInner> getWithResponse(String resourceGroupName, String kubernetesClusterName, String agentPoolName, Context context)

Retrieve the Kubernetes cluster agent pool. Get properties of the provided Kubernetes cluster agent pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
context - The context to associate with this operation.

Returns:

properties of the provided Kubernetes cluster agent pool along with Response<T>.

listByKubernetesCluster

public abstract PagedIterable<AgentPoolInner> listByKubernetesCluster(String resourceGroupName, String kubernetesClusterName)

List agent pools of the Kubernetes cluster. Get a list of agent pools for the provided Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.

Returns:

a list of agent pools for the provided Kubernetes cluster as paginated response with PagedIterable<T>.

listByKubernetesCluster

public abstract PagedIterable<AgentPoolInner> listByKubernetesCluster(String resourceGroupName, String kubernetesClusterName, Integer top, String skipToken, Context context)

List agent pools of the Kubernetes cluster. Get a list of agent pools for the provided Kubernetes cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of agent pools for the provided Kubernetes cluster as paginated response with PagedIterable<T>.

update

public abstract AgentPoolInner update(String resourceGroupName, String kubernetesClusterName, String agentPoolName)

Patch the Kubernetes cluster agent pool. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.

Returns:

agentPool represents the agent pool of Kubernetes cluster.

update

public abstract AgentPoolInner update(String resourceGroupName, String kubernetesClusterName, String agentPoolName, String ifMatch, String ifNoneMatch, AgentPoolPatchParameters agentPoolUpdateParameters, Context context)

Patch the Kubernetes cluster agent pool. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
kubernetesClusterName - The name of the Kubernetes cluster.
agentPoolName - The name of the Kubernetes cluster agent pool.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
agentPoolUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

agentPool represents the agent pool of Kubernetes cluster.

Applies to