agent¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azuredevops repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azuredevops repo.

class pulumi_azuredevops.agent.AwaitableGetPoolResult(auto_provision=None, id=None, name=None, pool_type=None)¶

class pulumi_azuredevops.agent.AwaitableGetPoolsResult(agent_pools=None, id=None)¶

class pulumi_azuredevops.agent.GetPoolResult(auto_provision=None, id=None, name=None, pool_type=None)¶

A collection of values returned by getPool.

id = None¶

The provider-assigned unique ID for this managed resource.

class pulumi_azuredevops.agent.GetPoolsResult(agent_pools=None, id=None)¶

A collection of values returned by getPools.

id = None¶

The provider-assigned unique ID for this managed resource.

class pulumi_azuredevops.agent.Pool(resource_name, opts=None, auto_provision=None, name=None, pool_type=None, __props__=None, __name__=None, __opts__=None)¶

Manages an agent pool within Azure DevOps.

import pulumi
import pulumi_azuredevops as azuredevops

pool = azuredevops.agent.Pool("pool", auto_provision=False)

• Azure DevOps Service REST API 5.1 - Agent Pools

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_provision (pulumi.Input[bool]) – Specifies whether or not a queue should be automatically provisioned for each project collection. Defaults to false.

• name (pulumi.Input[str]) – The name of the agent pool.

• pool_type (pulumi.Input[str]) – Specifies whether the agent pool type is Automation or Deployment. Defaults to automation.

auto_provision: pulumi.Output[bool] = None¶

Specifies whether or not a queue should be automatically provisioned for each project collection. Defaults to false.

name: pulumi.Output[str] = None¶

The name of the agent pool.

pool_type: pulumi.Output[str] = None¶

Specifies whether the agent pool type is Automation or Deployment. Defaults to automation.

static get(resource_name, id, opts=None, auto_provision=None, name=None, pool_type=None)¶

Get an existing Pool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• auto_provision (pulumi.Input[bool]) – Specifies whether or not a queue should be automatically provisioned for each project collection. Defaults to false.

• name (pulumi.Input[str]) – The name of the agent pool.

• pool_type (pulumi.Input[str]) – Specifies whether the agent pool type is Automation or Deployment. Defaults to automation.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azuredevops.agent.Queue(resource_name, opts=None, agent_pool_id=None, project_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an agent queue within Azure DevOps. In the UI, this is equivelant to adding an Organization defined pool to a project.

The created queue is not authorized for use by all pipeliens in the project. However, the Security.ResourceAuthorization resource can be used to grant authorization.

import pulumi
import pulumi_azuredevops as azuredevops

project = azuredevops.core.Project("project", project_name="Sample Project")
pool = azuredevops.Agent.get_pool(name="contoso-pool")
queue = azuredevops.agent.Queue("queue",
    project_id=project.id,
    agent_pool_id=pool.id)
# Grant acccess to queue to all pipelines in the project
auth = azuredevops.security.ResourceAuthorization("auth",
    project_id=project.id,
    resource_id=queue.id,
    type="queue",
    authorized=True)

• Azure DevOps Service REST API 5.1 - Agent Queues

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• agent_pool_id (pulumi.Input[float]) – The ID of the organization agent pool.

• project_id (pulumi.Input[str]) – The ID of the project in which to create the resource.

agent_pool_id: pulumi.Output[float] = None¶

The ID of the organization agent pool.

project_id: pulumi.Output[str] = None¶

The ID of the project in which to create the resource.

static get(resource_name, id, opts=None, agent_pool_id=None, project_id=None)¶

Get an existing Queue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• agent_pool_id (pulumi.Input[float]) – The ID of the organization agent pool.

• project_id (pulumi.Input[str]) – The ID of the project in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azuredevops.agent.get_pool(name=None, opts=None)¶

Use this data source to access information about an existing Agent Pool within Azure DevOps.

import pulumi
import pulumi_azuredevops as azuredevops

pool = azuredevops.Agent.get_pool(name="Sample Agent Pool")
pulumi.export("name", pool.name)
pulumi.export("poolType", pool.pool_type)
pulumi.export("autoProvision", pool.auto_provision)

• Azure DevOps Service REST API 5.1 - Agent Pools - Get

pulumi_azuredevops.agent.get_pools(opts=None)¶

Use this data source to access information about existing Agent Pools within Azure DevOps.

import pulumi
import pulumi_azuredevops as azuredevops

pools = azuredevops.Agent.get_pools()
pulumi.export("agentPoolName", [__item["name"] for __item in pools.agent_pools])
pulumi.export("autoProvision", [__item["auto_provision"] for __item in pools.agent_pools])
pulumi.export("poolType", [__item["pool_type"] for __item in pools.agent_pools])

• Azure DevOps Service REST API 5.1 - Agent Pools - Get