Docs Packages
  1. Packages
  2. AzureDevOps
  3. API Docs
  4. ElasticPool
Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ElasticPool

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages Elastic pool within Azure DevOps.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const exampleProject = new azuredevops.Project("exampleProject", {
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleServiceEndpointAzureRM = new azuredevops.ServiceEndpointAzureRM("exampleServiceEndpointAzureRM", {
    projectId: exampleProject.id,
    serviceEndpointName: "Example Azure Connection",
    description: "Managed by Terraform",
    serviceEndpointAuthenticationScheme: "ServicePrincipal",
    credentials: {
        serviceprincipalid: "00000000-0000-0000-0000-000000000000",
        serviceprincipalkey: "00000000-0000-0000-0000-000000000000",
    },
    azurermSpnTenantid: "00000000-0000-0000-0000-000000000000",
    azurermSubscriptionId: "00000000-0000-0000-0000-000000000000",
    azurermSubscriptionName: "Subscription Name",
});
const exampleElasticPool = new azuredevops.ElasticPool("exampleElasticPool", {
    serviceEndpointId: exampleServiceEndpointAzureRM.id,
    serviceEndpointScope: exampleProject.id,
    desiredIdle: 2,
    maxCapacity: 3,
    azureResourceId: "/subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_service_endpoint_azure_rm = azuredevops.ServiceEndpointAzureRM("exampleServiceEndpointAzureRM",
    project_id=example_project.id,
    service_endpoint_name="Example Azure Connection",
    description="Managed by Terraform",
    service_endpoint_authentication_scheme="ServicePrincipal",
    credentials=azuredevops.ServiceEndpointAzureRMCredentialsArgs(
        serviceprincipalid="00000000-0000-0000-0000-000000000000",
        serviceprincipalkey="00000000-0000-0000-0000-000000000000",
    ),
    azurerm_spn_tenantid="00000000-0000-0000-0000-000000000000",
    azurerm_subscription_id="00000000-0000-0000-0000-000000000000",
    azurerm_subscription_name="Subscription Name")
example_elastic_pool = azuredevops.ElasticPool("exampleElasticPool",
    service_endpoint_id=example_service_endpoint_azure_rm.id,
    service_endpoint_scope=example_project.id,
    desired_idle=2,
    max_capacity=3,
    azure_resource_id="/subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>")

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		exampleServiceEndpointAzureRM, err := azuredevops.NewServiceEndpointAzureRM(ctx, "exampleServiceEndpointAzureRM", &azuredevops.ServiceEndpointAzureRMArgs{
			ProjectId:                           exampleProject.ID(),
			ServiceEndpointName:                 pulumi.String("Example Azure Connection"),
			Description:                         pulumi.String("Managed by Terraform"),
			ServiceEndpointAuthenticationScheme: pulumi.String("ServicePrincipal"),
			Credentials: &azuredevops.ServiceEndpointAzureRMCredentialsArgs{
				Serviceprincipalid:  pulumi.String("00000000-0000-0000-0000-000000000000"),
				Serviceprincipalkey: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			AzurermSpnTenantid:      pulumi.String("00000000-0000-0000-0000-000000000000"),
			AzurermSubscriptionId:   pulumi.String("00000000-0000-0000-0000-000000000000"),
			AzurermSubscriptionName: pulumi.String("Subscription Name"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewElasticPool(ctx, "exampleElasticPool", &azuredevops.ElasticPoolArgs{
			ServiceEndpointId:    exampleServiceEndpointAzureRM.ID(),
			ServiceEndpointScope: exampleProject.ID(),
			DesiredIdle:          pulumi.Int(2),
			MaxCapacity:          pulumi.Int(3),
			AzureResourceId:      pulumi.String("/subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var exampleProject = new AzureDevOps.Project("exampleProject", new()
    {
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Terraform",
    });

    var exampleServiceEndpointAzureRM = new AzureDevOps.ServiceEndpointAzureRM("exampleServiceEndpointAzureRM", new()
    {
        ProjectId = exampleProject.Id,
        ServiceEndpointName = "Example Azure Connection",
        Description = "Managed by Terraform",
        ServiceEndpointAuthenticationScheme = "ServicePrincipal",
        Credentials = new AzureDevOps.Inputs.ServiceEndpointAzureRMCredentialsArgs
        {
            Serviceprincipalid = "00000000-0000-0000-0000-000000000000",
            Serviceprincipalkey = "00000000-0000-0000-0000-000000000000",
        },
        AzurermSpnTenantid = "00000000-0000-0000-0000-000000000000",
        AzurermSubscriptionId = "00000000-0000-0000-0000-000000000000",
        AzurermSubscriptionName = "Subscription Name",
    });

    var exampleElasticPool = new AzureDevOps.ElasticPool("exampleElasticPool", new()
    {
        ServiceEndpointId = exampleServiceEndpointAzureRM.Id,
        ServiceEndpointScope = exampleProject.Id,
        DesiredIdle = 2,
        MaxCapacity = 3,
        AzureResourceId = "/subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointAzureRM;
import com.pulumi.azuredevops.ServiceEndpointAzureRMArgs;
import com.pulumi.azuredevops.inputs.ServiceEndpointAzureRMCredentialsArgs;
import com.pulumi.azuredevops.ElasticPool;
import com.pulumi.azuredevops.ElasticPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceEndpointAzureRM = new ServiceEndpointAzureRM("exampleServiceEndpointAzureRM", ServiceEndpointAzureRMArgs.builder()        
            .projectId(exampleProject.id())
            .serviceEndpointName("Example Azure Connection")
            .description("Managed by Terraform")
            .serviceEndpointAuthenticationScheme("ServicePrincipal")
            .credentials(ServiceEndpointAzureRMCredentialsArgs.builder()
                .serviceprincipalid("00000000-0000-0000-0000-000000000000")
                .serviceprincipalkey("00000000-0000-0000-0000-000000000000")
                .build())
            .azurermSpnTenantid("00000000-0000-0000-0000-000000000000")
            .azurermSubscriptionId("00000000-0000-0000-0000-000000000000")
            .azurermSubscriptionName("Subscription Name")
            .build());

        var exampleElasticPool = new ElasticPool("exampleElasticPool", ElasticPoolArgs.builder()        
            .serviceEndpointId(exampleServiceEndpointAzureRM.id())
            .serviceEndpointScope(exampleProject.id())
            .desiredIdle(2)
            .maxCapacity(3)
            .azureResourceId("/subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>")
            .build());

    }
}

    resources:
  exampleProject:
    type: azuredevops:Project
    properties:
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleServiceEndpointAzureRM:
    type: azuredevops:ServiceEndpointAzureRM
    properties:
      projectId: ${exampleProject.id}
      serviceEndpointName: Example Azure Connection
      description: Managed by Terraform
      serviceEndpointAuthenticationScheme: ServicePrincipal
      credentials:
        serviceprincipalid: 00000000-0000-0000-0000-000000000000
        serviceprincipalkey: 00000000-0000-0000-0000-000000000000
      azurermSpnTenantid: 00000000-0000-0000-0000-000000000000
      azurermSubscriptionId: 00000000-0000-0000-0000-000000000000
      azurermSubscriptionName: Subscription Name
  exampleElasticPool:
    type: azuredevops:ElasticPool
    properties:
      serviceEndpointId: ${exampleServiceEndpointAzureRM.id}
      serviceEndpointScope: ${exampleProject.id}
      desiredIdle: 2
      maxCapacity: 3
      azureResourceId: /subscriptions/<Subscription Id>/resourceGroups/<Resource Name>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS Name>

    Create ElasticPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ElasticPool(name: string, args: ElasticPoolArgs, opts?: CustomResourceOptions);
    @overload
def ElasticPool(resource_name: str,
                args: ElasticPoolArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ElasticPool(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                azure_resource_id: Optional[str] = None,
                desired_idle: Optional[int] = None,
                max_capacity: Optional[int] = None,
                service_endpoint_id: Optional[str] = None,
                service_endpoint_scope: Optional[str] = None,
                agent_interactive_ui: Optional[bool] = None,
                auto_provision: Optional[bool] = None,
                auto_update: Optional[bool] = None,
                name: Optional[str] = None,
                project_id: Optional[str] = None,
                recycle_after_each_use: Optional[bool] = None,
                time_to_live_minutes: Optional[int] = None)
    func NewElasticPool(ctx *Context, name string, args ElasticPoolArgs, opts ...ResourceOption) (*ElasticPool, error)
    public ElasticPool(string name, ElasticPoolArgs args, CustomResourceOptions? opts = null)
    public ElasticPool(String name, ElasticPoolArgs args)
public ElasticPool(String name, ElasticPoolArgs args, CustomResourceOptions options)

    type: azuredevops:ElasticPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ElasticPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ElasticPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ElasticPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var elasticPoolResource = new AzureDevOps.ElasticPool("elasticPoolResource", new()
{
    AzureResourceId = "string",
    DesiredIdle = 0,
    MaxCapacity = 0,
    ServiceEndpointId = "string",
    ServiceEndpointScope = "string",
    AgentInteractiveUi = false,
    AutoProvision = false,
    AutoUpdate = false,
    Name = "string",
    ProjectId = "string",
    RecycleAfterEachUse = false,
    TimeToLiveMinutes = 0,
});

    example, err := azuredevops.NewElasticPool(ctx, "elasticPoolResource", &azuredevops.ElasticPoolArgs{
	AzureResourceId:      pulumi.String("string"),
	DesiredIdle:          pulumi.Int(0),
	MaxCapacity:          pulumi.Int(0),
	ServiceEndpointId:    pulumi.String("string"),
	ServiceEndpointScope: pulumi.String("string"),
	AgentInteractiveUi:   pulumi.Bool(false),
	AutoProvision:        pulumi.Bool(false),
	AutoUpdate:           pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	ProjectId:            pulumi.String("string"),
	RecycleAfterEachUse:  pulumi.Bool(false),
	TimeToLiveMinutes:    pulumi.Int(0),
})

    var elasticPoolResource = new ElasticPool("elasticPoolResource", ElasticPoolArgs.builder()        
    .azureResourceId("string")
    .desiredIdle(0)
    .maxCapacity(0)
    .serviceEndpointId("string")
    .serviceEndpointScope("string")
    .agentInteractiveUi(false)
    .autoProvision(false)
    .autoUpdate(false)
    .name("string")
    .projectId("string")
    .recycleAfterEachUse(false)
    .timeToLiveMinutes(0)
    .build());

    elastic_pool_resource = azuredevops.ElasticPool("elasticPoolResource",
    azure_resource_id="string",
    desired_idle=0,
    max_capacity=0,
    service_endpoint_id="string",
    service_endpoint_scope="string",
    agent_interactive_ui=False,
    auto_provision=False,
    auto_update=False,
    name="string",
    project_id="string",
    recycle_after_each_use=False,
    time_to_live_minutes=0)

    const elasticPoolResource = new azuredevops.ElasticPool("elasticPoolResource", {
    azureResourceId: "string",
    desiredIdle: 0,
    maxCapacity: 0,
    serviceEndpointId: "string",
    serviceEndpointScope: "string",
    agentInteractiveUi: false,
    autoProvision: false,
    autoUpdate: false,
    name: "string",
    projectId: "string",
    recycleAfterEachUse: false,
    timeToLiveMinutes: 0,
});

    type: azuredevops:ElasticPool
properties:
    agentInteractiveUi: false
    autoProvision: false
    autoUpdate: false
    azureResourceId: string
    desiredIdle: 0
    maxCapacity: 0
    name: string
    projectId: string
    recycleAfterEachUse: false
    serviceEndpointId: string
    serviceEndpointScope: string
    timeToLiveMinutes: 0

    ElasticPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ElasticPool resource accepts the following input properties:

    AzureResourceId string
    The ID of the Azure resource.
    DesiredIdle int
    Number of agents to keep on standby.
    MaxCapacity int
    Maximum number of virtual machines in the scale set.
    ServiceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    ServiceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    AgentInteractiveUi bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    AutoProvision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    AutoUpdate bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    Name string
    The name of the Elastic pool.
    ProjectId string
    The ID of the project where a new Elastic Pool will be created.
    RecycleAfterEachUse bool
    Tear down virtual machines after every use. Defaults to false.
    TimeToLiveMinutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    AzureResourceId string
    The ID of the Azure resource.
    DesiredIdle int
    Number of agents to keep on standby.
    MaxCapacity int
    Maximum number of virtual machines in the scale set.
    ServiceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    ServiceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    AgentInteractiveUi bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    AutoProvision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    AutoUpdate bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    Name string
    The name of the Elastic pool.
    ProjectId string
    The ID of the project where a new Elastic Pool will be created.
    RecycleAfterEachUse bool
    Tear down virtual machines after every use. Defaults to false.
    TimeToLiveMinutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    azureResourceId String
    The ID of the Azure resource.
    desiredIdle Integer
    Number of agents to keep on standby.
    maxCapacity Integer
    Maximum number of virtual machines in the scale set.
    serviceEndpointId String
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope String
    The Project ID of Service Endpoint belongs to.
    agentInteractiveUi Boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision Boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate Boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    name String
    The name of the Elastic pool.
    projectId String
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse Boolean
    Tear down virtual machines after every use. Defaults to false.
    timeToLiveMinutes Integer
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    azureResourceId string
    The ID of the Azure resource.
    desiredIdle number
    Number of agents to keep on standby.
    maxCapacity number
    Maximum number of virtual machines in the scale set.
    serviceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    agentInteractiveUi boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    name string
    The name of the Elastic pool.
    projectId string
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse boolean
    Tear down virtual machines after every use. Defaults to false.
    timeToLiveMinutes number
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    azure_resource_id str
    The ID of the Azure resource.
    desired_idle int
    Number of agents to keep on standby.
    max_capacity int
    Maximum number of virtual machines in the scale set.
    service_endpoint_id str
    The ID of Service Endpoint used to connect to Azure.
    service_endpoint_scope str
    The Project ID of Service Endpoint belongs to.
    agent_interactive_ui bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    auto_provision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    auto_update bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    name str
    The name of the Elastic pool.
    project_id str
    The ID of the project where a new Elastic Pool will be created.
    recycle_after_each_use bool
    Tear down virtual machines after every use. Defaults to false.
    time_to_live_minutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    azureResourceId String
    The ID of the Azure resource.
    desiredIdle Number
    Number of agents to keep on standby.
    maxCapacity Number
    Maximum number of virtual machines in the scale set.
    serviceEndpointId String
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope String
    The Project ID of Service Endpoint belongs to.
    agentInteractiveUi Boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision Boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate Boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    name String
    The name of the Elastic pool.
    projectId String
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse Boolean
    Tear down virtual machines after every use. Defaults to false.
    timeToLiveMinutes Number
    Delay in minutes before deleting excess idle agents. Defaults to 30.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ElasticPool resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ElasticPool Resource

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

    public static get(name: string, id: Input<ID>, state?: ElasticPoolState, opts?: CustomResourceOptions): ElasticPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_interactive_ui: Optional[bool] = None,
        auto_provision: Optional[bool] = None,
        auto_update: Optional[bool] = None,
        azure_resource_id: Optional[str] = None,
        desired_idle: Optional[int] = None,
        max_capacity: Optional[int] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        recycle_after_each_use: Optional[bool] = None,
        service_endpoint_id: Optional[str] = None,
        service_endpoint_scope: Optional[str] = None,
        time_to_live_minutes: Optional[int] = None) -> ElasticPool
    func GetElasticPool(ctx *Context, name string, id IDInput, state *ElasticPoolState, opts ...ResourceOption) (*ElasticPool, error)
    public static ElasticPool Get(string name, Input<string> id, ElasticPoolState? state, CustomResourceOptions? opts = null)
    public static ElasticPool get(String name, Output<String> id, ElasticPoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentInteractiveUi bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    AutoProvision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    AutoUpdate bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    AzureResourceId string
    The ID of the Azure resource.
    DesiredIdle int
    Number of agents to keep on standby.
    MaxCapacity int
    Maximum number of virtual machines in the scale set.
    Name string
    The name of the Elastic pool.
    ProjectId string
    The ID of the project where a new Elastic Pool will be created.
    RecycleAfterEachUse bool
    Tear down virtual machines after every use. Defaults to false.
    ServiceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    ServiceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    TimeToLiveMinutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    AgentInteractiveUi bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    AutoProvision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    AutoUpdate bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    AzureResourceId string
    The ID of the Azure resource.
    DesiredIdle int
    Number of agents to keep on standby.
    MaxCapacity int
    Maximum number of virtual machines in the scale set.
    Name string
    The name of the Elastic pool.
    ProjectId string
    The ID of the project where a new Elastic Pool will be created.
    RecycleAfterEachUse bool
    Tear down virtual machines after every use. Defaults to false.
    ServiceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    ServiceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    TimeToLiveMinutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    agentInteractiveUi Boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision Boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate Boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    azureResourceId String
    The ID of the Azure resource.
    desiredIdle Integer
    Number of agents to keep on standby.
    maxCapacity Integer
    Maximum number of virtual machines in the scale set.
    name String
    The name of the Elastic pool.
    projectId String
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse Boolean
    Tear down virtual machines after every use. Defaults to false.
    serviceEndpointId String
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope String
    The Project ID of Service Endpoint belongs to.
    timeToLiveMinutes Integer
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    agentInteractiveUi boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    azureResourceId string
    The ID of the Azure resource.
    desiredIdle number
    Number of agents to keep on standby.
    maxCapacity number
    Maximum number of virtual machines in the scale set.
    name string
    The name of the Elastic pool.
    projectId string
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse boolean
    Tear down virtual machines after every use. Defaults to false.
    serviceEndpointId string
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope string
    The Project ID of Service Endpoint belongs to.
    timeToLiveMinutes number
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    agent_interactive_ui bool
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    auto_provision bool
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    auto_update bool
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    azure_resource_id str
    The ID of the Azure resource.
    desired_idle int
    Number of agents to keep on standby.
    max_capacity int
    Maximum number of virtual machines in the scale set.
    name str
    The name of the Elastic pool.
    project_id str
    The ID of the project where a new Elastic Pool will be created.
    recycle_after_each_use bool
    Tear down virtual machines after every use. Defaults to false.
    service_endpoint_id str
    The ID of Service Endpoint used to connect to Azure.
    service_endpoint_scope str
    The Project ID of Service Endpoint belongs to.
    time_to_live_minutes int
    Delay in minutes before deleting excess idle agents. Defaults to 30.
    agentInteractiveUi Boolean
    Set whether agents should be configured to run with interactive UI. Defaults to false.
    autoProvision Boolean
    Specifies whether a queue should be automatically provisioned for each project collection. Defaults to false.
    autoUpdate Boolean
    Specifies whether or not agents within the pool should be automatically updated. Defaults to true.
    azureResourceId String
    The ID of the Azure resource.
    desiredIdle Number
    Number of agents to keep on standby.
    maxCapacity Number
    Maximum number of virtual machines in the scale set.
    name String
    The name of the Elastic pool.
    projectId String
    The ID of the project where a new Elastic Pool will be created.
    recycleAfterEachUse Boolean
    Tear down virtual machines after every use. Defaults to false.
    serviceEndpointId String
    The ID of Service Endpoint used to connect to Azure.
    serviceEndpointScope String
    The Project ID of Service Endpoint belongs to.
    timeToLiveMinutes Number
    Delay in minutes before deleting excess idle agents. Defaults to 30.

    Import

    Azure DevOps Agent Pools can be imported using the Elastic pool ID, e.g.

    $ pulumi import azuredevops:index/elasticPool:ElasticPool example 0

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi
    pulumi/pulumi-azuredevops