Package version:

Interface AgentPools

Interface representing a AgentPools.

Hierarchy

AgentPools

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getQueueStatus list

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
Creates an agent pool for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- agentPool: AgentPool
  
  The parameters of an agent pool that needs to scheduled.
- Optional options: AgentPoolsCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
- Defined in operationsInterfaces/agentPools.ts:61

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<AgentPool>
Creates an agent pool for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- agentPool: AgentPool
  
  The parameters of an agent pool that needs to scheduled.
- Optional options: AgentPoolsCreateOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPools.ts:81

beginDelete

beginDelete(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a specified agent pool resource.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- Optional options: AgentPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/agentPools.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<void>
Deletes a specified agent pool resource.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- Optional options: AgentPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/agentPools.ts:108

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
Updates an agent pool with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- updateParameters: AgentPoolUpdateParameters
  
  The parameters for updating an agent pool.
- Optional options: AgentPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AgentPool>, AgentPool>>
- Defined in operationsInterfaces/agentPools.ts:122

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<AgentPool>
Updates an agent pool with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- updateParameters: AgentPoolUpdateParameters
  
  The parameters for updating an agent pool.
- Optional options: AgentPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPools.ts:142

get

get(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>
Gets the detailed information for a given agent pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- Optional options: AgentPoolsGetOptionalParams
  
  The options parameters.
Returns Promise<AgentPool>
- Defined in operationsInterfaces/agentPools.ts:47

getQueueStatus

getQueueStatus(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetQueueStatusOptionalParams): Promise<AgentPoolQueueStatus>
Gets the count of queued runs for a given agent pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- agentPoolName: string
  
  The name of the agent pool.
- Optional options: AgentPoolsGetQueueStatusOptionalParams
  
  The options parameters.
Returns Promise<AgentPoolQueueStatus>
- Defined in operationsInterfaces/agentPools.ts:156

list

list(resourceGroupName: string, registryName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool>
Lists all the agent pools for a specified container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: AgentPoolsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AgentPool>
- Defined in operationsInterfaces/agentPools.ts:35

Interface AgentPools

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolsCreateOptionalParams

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

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolsCreateOptionalParams

Returns Promise<AgentPool>

beginDelete

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

updateParameters: AgentPoolUpdateParameters

Optional options: AgentPoolsUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

updateParameters: AgentPoolUpdateParameters

Optional options: AgentPoolsUpdateOptionalParams

Returns Promise<AgentPool>

get

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsGetOptionalParams

Returns Promise<AgentPool>

getQueueStatus

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsGetQueueStatusOptionalParams

Returns Promise<AgentPoolQueueStatus>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: AgentPoolsListOptionalParams

Returns PagedAsyncIterableIterator<AgentPool>

Settings

Member Visibility

Theme

`Optional` options: AgentPoolsCreateOptionalParams

`Optional` options: AgentPoolsCreateOptionalParams

`Optional` options: AgentPoolsDeleteOptionalParams

`Optional` options: AgentPoolsDeleteOptionalParams

`Optional` options: AgentPoolsUpdateOptionalParams

`Optional` options: AgentPoolsUpdateOptionalParams

`Optional` options: AgentPoolsGetOptionalParams

`Optional` options: AgentPoolsGetQueueStatusOptionalParams

`Optional` options: AgentPoolsListOptionalParams