Package version:

Interface AgentPools

Interface representing a AgentPools.

interface AgentPools {
    beginCreate(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>;
    beginCreateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, agentPool: AgentPool, options?: AgentPoolsCreateOptionalParams): Promise<AgentPool>;
    beginDelete(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsDeleteHeaders>, AgentPoolsDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<AgentPoolsDeleteHeaders>;
    beginUpdate(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>;
    beginUpdateAndWait(resourceGroupName: string, registryName: string, agentPoolName: string, updateParameters: AgentPoolUpdateParameters, options?: AgentPoolsUpdateOptionalParams): Promise<AgentPool>;
    get(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>;
    getQueueStatus(resourceGroupName: string, registryName: string, agentPoolName: string, options?: AgentPoolsGetQueueStatusOptionalParams): Promise<AgentPoolQueueStatus>;
    list(resourceGroupName: string, registryName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getQueueStatus list

Methods

beginCreate

  • beginCreate(resourceGroupName, registryName, agentPoolName, agentPool, options?): Promise<SimplePollerLike<OperationState<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.

    • Optionaloptions: AgentPoolsCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>

beginCreateAndWait

  • beginCreateAndWait(resourceGroupName, registryName, agentPoolName, agentPool, options?): 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.

    • Optionaloptions: AgentPoolsCreateOptionalParams

      The options parameters.

    Returns Promise<AgentPool>

beginDelete

beginDeleteAndWait

beginUpdate

  • beginUpdate(resourceGroupName, registryName, agentPoolName, updateParameters, options?): Promise<SimplePollerLike<OperationState<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.

    • Optionaloptions: AgentPoolsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, registryName, agentPoolName, updateParameters, options?): 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.

    • Optionaloptions: AgentPoolsUpdateOptionalParams

      The options parameters.

    Returns Promise<AgentPool>

get

  • get(resourceGroupName, registryName, agentPoolName, options?): 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.

    • Optionaloptions: AgentPoolsGetOptionalParams

      The options parameters.

    Returns Promise<AgentPool>

getQueueStatus

list

  • list(resourceGroupName, registryName, options?): 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.

    • Optionaloptions: AgentPoolsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<AgentPool>

Settings

Member Visibility