Package version:

Interface AgentPoolOperations

Interface representing a AgentPoolOperations.

Hierarchy

AgentPoolOperations

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait delete get listByProvisionedCluster update

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, provisionedClustersName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
Creates the agent pool in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- agentPoolName: string
  
  Parameter for the name of the agent pool in the provisioned cluster
- agentPool: AgentPool
  
  The agentPool resource definition
- Optional options: AgentPoolCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
- Defined in operationsInterfaces/agentPoolOperations.ts:46

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, provisionedClustersName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolCreateOrUpdateOptionalParams): Promise<AgentPool>
Creates the agent pool in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- agentPoolName: string
  
  Parameter for the name of the agent pool in the provisioned cluster
- agentPool: AgentPool
  
  The agentPool resource definition
- Optional options: AgentPoolCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPoolOperations.ts:66

delete

delete(resourceGroupName: string, provisionedClustersName: string, agentPoolName: string, options?: AgentPoolDeleteOptionalParams): Promise<void>
Deletes the agent pool in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- agentPoolName: string
  
  Parameter for the name of the agent pool in the provisioned cluster
- Optional options: AgentPoolDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/agentPoolOperations.ts:80

get

get(resourceGroupName: string, provisionedClustersName: string, agentPoolName: string, options?: AgentPoolGetOptionalParams): Promise<AgentPool>
Gets the agent pool in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- agentPoolName: string
  
  Parameter for the name of the agent pool in the provisioned cluster
- Optional options: AgentPoolGetOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPoolOperations.ts:32

listByProvisionedCluster

listByProvisionedCluster(resourceGroupName: string, provisionedClustersName: string, options?: AgentPoolListByProvisionedClusterOptionalParams): Promise<AgentPoolListResult>
Gets the agent pools in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- Optional options: AgentPoolListByProvisionedClusterOptionalParams
  
  The options parameters.
Returns Promise<AgentPoolListResult>
- Defined in operationsInterfaces/agentPoolOperations.ts:107

update

update(resourceGroupName: string, provisionedClustersName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolUpdateOptionalParams): Promise<AgentPool>
Updates the agent pool in the Hybrid AKS provisioned cluster
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- provisionedClustersName: string
  
  Parameter for the name of the provisioned cluster
- agentPoolName: string
  
  Parameter for the name of the agent pool in the provisioned cluster
- agentPool: AgentPool
  
  The agentPool resource definition
- Optional options: AgentPoolUpdateOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPoolOperations.ts:94

Interface AgentPoolOperations

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

provisionedClustersName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

provisionedClustersName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolCreateOrUpdateOptionalParams

Returns Promise<AgentPool>

delete

Parameters

resourceGroupName: string

provisionedClustersName: string

agentPoolName: string

Optional options: AgentPoolDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

provisionedClustersName: string

agentPoolName: string

Optional options: AgentPoolGetOptionalParams

Returns Promise<AgentPool>

listByProvisionedCluster

Parameters

resourceGroupName: string

provisionedClustersName: string

Optional options: AgentPoolListByProvisionedClusterOptionalParams

Returns Promise<AgentPoolListResult>

update

Parameters

resourceGroupName: string

provisionedClustersName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolUpdateOptionalParams

Returns Promise<AgentPool>

Settings

Member Visibility

Theme

`Optional` options: AgentPoolCreateOrUpdateOptionalParams

`Optional` options: AgentPoolCreateOrUpdateOptionalParams

`Optional` options: AgentPoolDeleteOptionalParams

`Optional` options: AgentPoolGetOptionalParams

`Optional` options: AgentPoolListByProvisionedClusterOptionalParams

`Optional` options: AgentPoolUpdateOptionalParams