AgentPoolsImpl | @azure/arm-containerregistry

Class containing AgentPools operations.

Hierarchy

AgentPoolsImpl

Implements

AgentPools

Index

Constructors

constructor

Methods

Constructors

constructor

new AgentPoolsImpl(client: ContainerRegistryManagementClient): AgentPoolsImpl

- Defined in operations/agentPools.ts:38
Initialize a new instance of the class AgentPools class.

Parameters
- client: ContainerRegistryManagementClient
  
  Reference to the service client
Returns AgentPoolsImpl

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<PollerLike<PollOperationState<AgentPoolsCreateResponse>, AgentPoolsCreateResponse>>

Implementation of AgentPools.beginCreate
- Defined in operations/agentPools.ts:134
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<AgentPoolsCreateResponse>, AgentPoolsCreateResponse>>

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<AgentPoolsCreateResponse>

Implementation of AgentPools.beginCreateAndWait
- Defined in operations/agentPools.ts:206
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<AgentPoolsCreateResponse>

beginDelete

beginDelete(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of AgentPools.beginDelete
- Defined in operations/agentPools.ts:230
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>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<void>

Implementation of AgentPools.beginDeleteAndWait
- Defined in operations/agentPools.ts:295
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>

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AgentPoolsUpdateResponse>, AgentPoolsUpdateResponse>>

Implementation of AgentPools.beginUpdate
- Defined in operations/agentPools.ts:318
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<AgentPoolsUpdateResponse>, AgentPoolsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<AgentPoolsUpdateResponse>

Implementation of AgentPools.beginUpdateAndWait
- Defined in operations/agentPools.ts:396
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<AgentPoolsUpdateResponse>

get

get(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPoolsGetResponse>

Implementation of AgentPools.get
- Defined in operations/agentPools.ts:114
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<AgentPoolsGetResponse>

getQueueStatus

getQueueStatus(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetQueueStatusOptionalParams): Promise<AgentPoolsGetQueueStatusResponse>

Implementation of AgentPools.getQueueStatus
- Defined in operations/agentPools.ts:437
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<AgentPoolsGetQueueStatusResponse>

list

list(resourceGroupName: string, registryName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool>

Implementation of AgentPools.list
- Defined in operations/agentPools.ts:54
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>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ContainerRegistryManagementClient

Returns AgentPoolsImpl

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolsCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<AgentPoolsCreateResponse>, AgentPoolsCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

agentPool: AgentPool

Optional options: AgentPoolsCreateOptionalParams

Returns Promise<AgentPoolsCreateResponse>

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<AgentPoolsUpdateResponse>, AgentPoolsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

updateParameters: AgentPoolUpdateParameters

Optional options: AgentPoolsUpdateOptionalParams

Returns Promise<AgentPoolsUpdateResponse>

get

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsGetOptionalParams

Returns Promise<AgentPoolsGetResponse>

getQueueStatus

Parameters

resourceGroupName: string

registryName: string

agentPoolName: string

Optional options: AgentPoolsGetQueueStatusOptionalParams

Returns Promise<AgentPoolsGetQueueStatusResponse>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: AgentPoolsListOptionalParams

Returns PagedAsyncIterableIterator<AgentPool>