Azure DevOps v2.7.0, Mar 27 23
Azure DevOps v2.7.0, Mar 27 23
azuredevops.Pool
Explore with Pulumi AI
Manages an agent pool within Azure DevOps.
Relevant Links
Example Usage
using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var example = new AzureDevOps.Pool("example", new()
{
AutoProvision = false,
AutoUpdate = false,
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := azuredevops.NewPool(ctx, "example", &azuredevops.PoolArgs{
AutoProvision: pulumi.Bool(false),
AutoUpdate: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Pool;
import com.pulumi.azuredevops.PoolArgs;
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 example = new Pool("example", PoolArgs.builder()
.autoProvision(false)
.autoUpdate(false)
.build());
}
}
import pulumi
import pulumi_azuredevops as azuredevops
example = azuredevops.Pool("example",
auto_provision=False,
auto_update=False)
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const example = new azuredevops.Pool("example", {
autoProvision: false,
autoUpdate: false,
});
resources:
example:
type: azuredevops:Pool
properties:
autoProvision: false
autoUpdate: false
Create Pool Resource
new Pool(name: string, args?: PoolArgs, opts?: CustomResourceOptions);
@overload
def Pool(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_provision: Optional[bool] = None,
auto_update: Optional[bool] = None,
name: Optional[str] = None,
pool_type: Optional[str] = None)
@overload
def Pool(resource_name: str,
args: Optional[PoolArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewPool(ctx *Context, name string, args *PoolArgs, opts ...ResourceOption) (*Pool, error)
public Pool(string name, PoolArgs? args = null, CustomResourceOptions? opts = null)
type: azuredevops:Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PoolArgs
- 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 PoolArgs
- 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 PoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Pool 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 Pool resource accepts the following input properties:
- 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 string
The name of the agent pool.
- Pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- 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 string
The name of the agent pool.
- Pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision Boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update Boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name String
The name of the agent pool.
- pool
Type String Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name string
The name of the agent pool.
- pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- 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 agent pool.
- pool_
type str Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision Boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update Boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name String
The name of the agent pool.
- pool
Type String Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Pool 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 Pool Resource
Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_provision: Optional[bool] = None,
auto_update: Optional[bool] = None,
name: Optional[str] = None,
pool_type: Optional[str] = None) -> Pool
func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)
public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)
public static Pool get(String name, Output<String> id, PoolState 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.
- 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 string
The name of the agent pool.
- Pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- 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 string
The name of the agent pool.
- Pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision Boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update Boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name String
The name of the agent pool.
- pool
Type String Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name string
The name of the agent pool.
- pool
Type string Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- 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 agent pool.
- pool_
type str Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
- auto
Provision Boolean Specifies whether a queue should be automatically provisioned for each project collection. Defaults to
false
.- auto
Update Boolean Specifies whether or not agents within the pool should be automatically updated. Defaults to
true
.- name String
The name of the agent pool.
- pool
Type String Specifies whether the agent pool type is Automation or Deployment. Defaults to
automation
.
Import
Azure DevOps Agent Pools can be imported using the agent pool ID, e.g.
$ pulumi import azuredevops:index/pool:Pool example 0
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuredevops
Terraform Provider.