AgentPoolOperations interface

Interface representing a AgentPoolOperations.

Methods

beginCreateOrUpdate(string, string, AgentPool, AgentPoolCreateOrUpdateOptionalParams)

Creates or updates the agent pool in the provisioned cluster

beginCreateOrUpdateAndWait(string, string, AgentPool, AgentPoolCreateOrUpdateOptionalParams)

Creates or updates the agent pool in the provisioned cluster

beginDelete(string, string, AgentPoolDeleteOptionalParams)

Deletes the specified agent pool in the provisioned cluster

beginDeleteAndWait(string, string, AgentPoolDeleteOptionalParams)

Deletes the specified agent pool in the provisioned cluster

get(string, string, AgentPoolGetOptionalParams)

Gets the specified agent pool in the provisioned cluster

listByProvisionedCluster(string, AgentPoolListByProvisionedClusterOptionalParams)

Gets the list of agent pools in the specified provisioned cluster

Method Details

beginCreateOrUpdate(string, string, AgentPool, AgentPoolCreateOrUpdateOptionalParams)

Creates or updates the agent pool in the provisioned cluster

function beginCreateOrUpdate(connectedClusterResourceUri: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

agentPoolName

string

Parameter for the name of the agent pool in the provisioned cluster.

agentPool
AgentPool

Agent Pool resource definition

options
AgentPoolCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>

beginCreateOrUpdateAndWait(string, string, AgentPool, AgentPoolCreateOrUpdateOptionalParams)

Creates or updates the agent pool in the provisioned cluster

function beginCreateOrUpdateAndWait(connectedClusterResourceUri: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolCreateOrUpdateOptionalParams): Promise<AgentPool>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

agentPoolName

string

Parameter for the name of the agent pool in the provisioned cluster.

agentPool
AgentPool

Agent Pool resource definition

options
AgentPoolCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AgentPool>

beginDelete(string, string, AgentPoolDeleteOptionalParams)

Deletes the specified agent pool in the provisioned cluster

function beginDelete(connectedClusterResourceUri: string, agentPoolName: string, options?: AgentPoolDeleteOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolDeleteHeaders>, AgentPoolDeleteHeaders>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

agentPoolName

string

Parameter for the name of the agent pool in the provisioned cluster.

options
AgentPoolDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolDeleteHeaders>, AgentPoolDeleteHeaders>>

beginDeleteAndWait(string, string, AgentPoolDeleteOptionalParams)

Deletes the specified agent pool in the provisioned cluster

function beginDeleteAndWait(connectedClusterResourceUri: string, agentPoolName: string, options?: AgentPoolDeleteOptionalParams): Promise<AgentPoolDeleteHeaders>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

agentPoolName

string

Parameter for the name of the agent pool in the provisioned cluster.

options
AgentPoolDeleteOptionalParams

The options parameters.

Returns

get(string, string, AgentPoolGetOptionalParams)

Gets the specified agent pool in the provisioned cluster

function get(connectedClusterResourceUri: string, agentPoolName: string, options?: AgentPoolGetOptionalParams): Promise<AgentPool>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

agentPoolName

string

Parameter for the name of the agent pool in the provisioned cluster.

options
AgentPoolGetOptionalParams

The options parameters.

Returns

Promise<AgentPool>

listByProvisionedCluster(string, AgentPoolListByProvisionedClusterOptionalParams)

Gets the list of agent pools in the specified provisioned cluster

function listByProvisionedCluster(connectedClusterResourceUri: string, options?: AgentPoolListByProvisionedClusterOptionalParams): PagedAsyncIterableIterator<AgentPool, AgentPool[], PageSettings>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource Manager identifier of the connected cluster resource.

options
AgentPoolListByProvisionedClusterOptionalParams

The options parameters.

Returns