AgentPools interface
Interface representing a AgentPools.
Methods
Method Details
beginCreate(string, string, string, AgentPool, AgentPoolsCreateOptionalParams)
Creates an agent pool for a container registry with the specified parameters.
function beginCreate(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>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.
- options
- AgentPoolsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginCreateAndWait(string, string, string, AgentPool, AgentPoolsCreateOptionalParams)
Creates an agent pool for a container registry with the specified parameters.
function beginCreateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<AgentPool>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.
- options
- AgentPoolsCreateOptionalParams
The options parameters.
Returns
Promise<AgentPool>
beginDelete(string, string, string, AgentPoolsDeleteOptionalParams)
Deletes a specified agent pool resource.
function beginDelete(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AgentPoolsDeleteOptionalParams)
Deletes a specified agent pool resource.
function beginDeleteAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<void>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.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, AgentPoolUpdateParameters, AgentPoolsUpdateOptionalParams)
Updates an agent pool with the specified parameters.
function beginUpdate(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>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.
- options
- AgentPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginUpdateAndWait(string, string, string, AgentPoolUpdateParameters, AgentPoolsUpdateOptionalParams)
Updates an agent pool with the specified parameters.
function beginUpdateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<AgentPool>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.
- options
- AgentPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<AgentPool>
get(string, string, string, AgentPoolsGetOptionalParams)
Gets the detailed information for a given agent pool.
function get(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>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.
- options
- AgentPoolsGetOptionalParams
The options parameters.
Returns
Promise<AgentPool>
getQueueStatus(string, string, string, AgentPoolsGetQueueStatusOptionalParams)
Gets the count of queued runs for a given agent pool.
function getQueueStatus(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetQueueStatusOptionalParams): Promise<AgentPoolQueueStatus>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.
The options parameters.
Returns
Promise<AgentPoolQueueStatus>
list(string, string, AgentPoolsListOptionalParams)
Lists all the agent pools for a specified container registry.
function list(resourceGroupName: string, registryName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool, AgentPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- options
- AgentPoolsListOptionalParams
The options parameters.