agent

package
v2.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 11, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetPoolsAgentPool

type GetPoolsAgentPool struct {
	// Specifies whether or not a queue should be automatically provisioned for each project collection.
	AutoProvision bool `pulumi:"autoProvision"`
	// Specifies whether or not agents within the pool should be automatically updated.
	AutoUpdate bool `pulumi:"autoUpdate"`
	Id         int  `pulumi:"id"`
	// The name of the agent pool
	Name string `pulumi:"name"`
	// Specifies whether the agent pool type is Automation or Deployment.
	PoolType string `pulumi:"poolType"`
}

type GetPoolsAgentPoolArgs

type GetPoolsAgentPoolArgs struct {
	// Specifies whether or not a queue should be automatically provisioned for each project collection.
	AutoProvision pulumi.BoolInput `pulumi:"autoProvision"`
	// Specifies whether or not agents within the pool should be automatically updated.
	AutoUpdate pulumi.BoolInput `pulumi:"autoUpdate"`
	Id         pulumi.IntInput  `pulumi:"id"`
	// The name of the agent pool
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies whether the agent pool type is Automation or Deployment.
	PoolType pulumi.StringInput `pulumi:"poolType"`
}

func (GetPoolsAgentPoolArgs) ElementType

func (GetPoolsAgentPoolArgs) ElementType() reflect.Type

func (GetPoolsAgentPoolArgs) ToGetPoolsAgentPoolOutput

func (i GetPoolsAgentPoolArgs) ToGetPoolsAgentPoolOutput() GetPoolsAgentPoolOutput

func (GetPoolsAgentPoolArgs) ToGetPoolsAgentPoolOutputWithContext

func (i GetPoolsAgentPoolArgs) ToGetPoolsAgentPoolOutputWithContext(ctx context.Context) GetPoolsAgentPoolOutput

type GetPoolsAgentPoolArray

type GetPoolsAgentPoolArray []GetPoolsAgentPoolInput

func (GetPoolsAgentPoolArray) ElementType

func (GetPoolsAgentPoolArray) ElementType() reflect.Type

func (GetPoolsAgentPoolArray) ToGetPoolsAgentPoolArrayOutput

func (i GetPoolsAgentPoolArray) ToGetPoolsAgentPoolArrayOutput() GetPoolsAgentPoolArrayOutput

func (GetPoolsAgentPoolArray) ToGetPoolsAgentPoolArrayOutputWithContext

func (i GetPoolsAgentPoolArray) ToGetPoolsAgentPoolArrayOutputWithContext(ctx context.Context) GetPoolsAgentPoolArrayOutput

type GetPoolsAgentPoolArrayInput

type GetPoolsAgentPoolArrayInput interface {
	pulumi.Input

	ToGetPoolsAgentPoolArrayOutput() GetPoolsAgentPoolArrayOutput
	ToGetPoolsAgentPoolArrayOutputWithContext(context.Context) GetPoolsAgentPoolArrayOutput
}

GetPoolsAgentPoolArrayInput is an input type that accepts GetPoolsAgentPoolArray and GetPoolsAgentPoolArrayOutput values. You can construct a concrete instance of `GetPoolsAgentPoolArrayInput` via:

GetPoolsAgentPoolArray{ GetPoolsAgentPoolArgs{...} }

type GetPoolsAgentPoolArrayOutput

type GetPoolsAgentPoolArrayOutput struct{ *pulumi.OutputState }

func (GetPoolsAgentPoolArrayOutput) ElementType

func (GetPoolsAgentPoolArrayOutput) Index

func (GetPoolsAgentPoolArrayOutput) ToGetPoolsAgentPoolArrayOutput

func (o GetPoolsAgentPoolArrayOutput) ToGetPoolsAgentPoolArrayOutput() GetPoolsAgentPoolArrayOutput

func (GetPoolsAgentPoolArrayOutput) ToGetPoolsAgentPoolArrayOutputWithContext

func (o GetPoolsAgentPoolArrayOutput) ToGetPoolsAgentPoolArrayOutputWithContext(ctx context.Context) GetPoolsAgentPoolArrayOutput

type GetPoolsAgentPoolInput

type GetPoolsAgentPoolInput interface {
	pulumi.Input

	ToGetPoolsAgentPoolOutput() GetPoolsAgentPoolOutput
	ToGetPoolsAgentPoolOutputWithContext(context.Context) GetPoolsAgentPoolOutput
}

GetPoolsAgentPoolInput is an input type that accepts GetPoolsAgentPoolArgs and GetPoolsAgentPoolOutput values. You can construct a concrete instance of `GetPoolsAgentPoolInput` via:

GetPoolsAgentPoolArgs{...}

type GetPoolsAgentPoolOutput

type GetPoolsAgentPoolOutput struct{ *pulumi.OutputState }

func (GetPoolsAgentPoolOutput) AutoProvision

func (o GetPoolsAgentPoolOutput) AutoProvision() pulumi.BoolOutput

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

func (GetPoolsAgentPoolOutput) AutoUpdate added in v2.7.0

func (o GetPoolsAgentPoolOutput) AutoUpdate() pulumi.BoolOutput

Specifies whether or not agents within the pool should be automatically updated.

func (GetPoolsAgentPoolOutput) ElementType

func (GetPoolsAgentPoolOutput) ElementType() reflect.Type

func (GetPoolsAgentPoolOutput) Id

func (GetPoolsAgentPoolOutput) Name

The name of the agent pool

func (GetPoolsAgentPoolOutput) PoolType

Specifies whether the agent pool type is Automation or Deployment.

func (GetPoolsAgentPoolOutput) ToGetPoolsAgentPoolOutput

func (o GetPoolsAgentPoolOutput) ToGetPoolsAgentPoolOutput() GetPoolsAgentPoolOutput

func (GetPoolsAgentPoolOutput) ToGetPoolsAgentPoolOutputWithContext

func (o GetPoolsAgentPoolOutput) ToGetPoolsAgentPoolOutputWithContext(ctx context.Context) GetPoolsAgentPoolOutput

type GetPoolsResult

type GetPoolsResult struct {
	// A list of existing agent pools in your Azure DevOps Organization with the following details about every agent pool:
	AgentPools []GetPoolsAgentPool `pulumi:"agentPools"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

A collection of values returned by getPools.

func GetPools deprecated

func GetPools(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetPoolsResult, error)

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuredevops.GetPools(ctx, nil, nil)
		if err != nil {
			return err
		}
		var splat0 []*string
		for _, val0 := range example.AgentPools {
			splat0 = append(splat0, val0.Name)
		}
		ctx.Export("agentPoolName", splat0)
		var splat1 []*bool
		for _, val0 := range example.AgentPools {
			splat1 = append(splat1, val0.AutoProvision)
		}
		ctx.Export("autoProvision", splat1)
		var splat2 []*bool
		for _, val0 := range example.AgentPools {
			splat2 = append(splat2, val0.AutoUpdate)
		}
		ctx.Export("autoUpdate", splat2)
		var splat3 []*string
		for _, val0 := range example.AgentPools {
			splat3 = append(splat3, val0.PoolType)
		}
		ctx.Export("poolType", splat3)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Relevant Links

- [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)

Deprecated: azuredevops.agent.getPools has been deprecated in favor of azuredevops.getPools

type GetPoolsResultOutput added in v2.14.0

type GetPoolsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPools.

func GetPoolsOutput added in v2.14.0

func GetPoolsOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetPoolsResultOutput

func (GetPoolsResultOutput) AgentPools added in v2.14.0

A list of existing agent pools in your Azure DevOps Organization with the following details about every agent pool:

func (GetPoolsResultOutput) ElementType added in v2.14.0

func (GetPoolsResultOutput) ElementType() reflect.Type

func (GetPoolsResultOutput) Id added in v2.14.0

The provider-assigned unique ID for this managed resource.

func (GetPoolsResultOutput) ToGetPoolsResultOutput added in v2.14.0

func (o GetPoolsResultOutput) ToGetPoolsResultOutput() GetPoolsResultOutput

func (GetPoolsResultOutput) ToGetPoolsResultOutputWithContext added in v2.14.0

func (o GetPoolsResultOutput) ToGetPoolsResultOutputWithContext(ctx context.Context) GetPoolsResultOutput

type LookupPoolArgs

type LookupPoolArgs struct {
	// Name of the Agent Pool.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getPool.

type LookupPoolOutputArgs added in v2.3.0

type LookupPoolOutputArgs struct {
	// Name of the Agent Pool.
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getPool.

func (LookupPoolOutputArgs) ElementType added in v2.3.0

func (LookupPoolOutputArgs) ElementType() reflect.Type

type LookupPoolResult

type LookupPoolResult struct {
	AutoProvision bool `pulumi:"autoProvision"`
	AutoUpdate    bool `pulumi:"autoUpdate"`
	// The provider-assigned unique ID for this managed resource.
	Id       string `pulumi:"id"`
	Name     string `pulumi:"name"`
	PoolType string `pulumi:"poolType"`
}

A collection of values returned by getPool.

func LookupPool deprecated

func LookupPool(ctx *pulumi.Context, args *LookupPoolArgs, opts ...pulumi.InvokeOption) (*LookupPoolResult, error)

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

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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 {
		example, err := azuredevops.LookupPool(ctx, &azuredevops.LookupPoolArgs{
			Name: "Example Agent Pool",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("name", example.Name)
		ctx.Export("poolType", example.PoolType)
		ctx.Export("autoProvision", example.AutoProvision)
		ctx.Export("autoUpdate", example.AutoUpdate)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Relevant Links

- [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)

Deprecated: azuredevops.agent.getPool has been deprecated in favor of azuredevops.getPool

type LookupPoolResultOutput added in v2.3.0

type LookupPoolResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPool.

func LookupPoolOutput added in v2.3.0

func LookupPoolOutput(ctx *pulumi.Context, args LookupPoolOutputArgs, opts ...pulumi.InvokeOption) LookupPoolResultOutput

func (LookupPoolResultOutput) AutoProvision added in v2.3.0

func (o LookupPoolResultOutput) AutoProvision() pulumi.BoolOutput

func (LookupPoolResultOutput) AutoUpdate added in v2.7.0

func (o LookupPoolResultOutput) AutoUpdate() pulumi.BoolOutput

func (LookupPoolResultOutput) ElementType added in v2.3.0

func (LookupPoolResultOutput) ElementType() reflect.Type

func (LookupPoolResultOutput) Id added in v2.3.0

The provider-assigned unique ID for this managed resource.

func (LookupPoolResultOutput) Name added in v2.3.0

func (LookupPoolResultOutput) PoolType added in v2.3.0

func (LookupPoolResultOutput) ToLookupPoolResultOutput added in v2.3.0

func (o LookupPoolResultOutput) ToLookupPoolResultOutput() LookupPoolResultOutput

func (LookupPoolResultOutput) ToLookupPoolResultOutputWithContext added in v2.3.0

func (o LookupPoolResultOutput) ToLookupPoolResultOutputWithContext(ctx context.Context) LookupPoolResultOutput

type Pool deprecated

type Pool struct {
	pulumi.CustomResourceState

	// Specifies whether a queue should be automatically provisioned for each project collection. Defaults to `false`.
	AutoProvision pulumi.BoolPtrOutput `pulumi:"autoProvision"`
	// Specifies whether or not agents within the pool should be automatically updated. Defaults to `true`.
	AutoUpdate pulumi.BoolPtrOutput `pulumi:"autoUpdate"`
	// The name of the agent pool.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies whether the agent pool type is Automation or Deployment. Defaults to `automation`.
	PoolType pulumi.StringPtrOutput `pulumi:"poolType"`
}

Manages an agent pool within Azure DevOps.

## Example Usage

<!--Start PulumiCodeChooser --> ```go 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
	})
}

``` <!--End PulumiCodeChooser -->

## Relevant Links

- [Azure DevOps Service REST API 7.0 - Agent Pools](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools?view=azure-devops-rest-7.0)

## Import

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

```sh $ pulumi import azuredevops:Agent/pool:Pool example 0 ```

Deprecated: azuredevops.agent.Pool has been deprecated in favor of azuredevops.Pool

func GetPool

func GetPool(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PoolState, opts ...pulumi.ResourceOption) (*Pool, error)

GetPool gets an existing Pool resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPool

func NewPool(ctx *pulumi.Context,
	name string, args *PoolArgs, opts ...pulumi.ResourceOption) (*Pool, error)

NewPool registers a new resource with the given unique name, arguments, and options.

func (*Pool) ElementType

func (*Pool) ElementType() reflect.Type

func (*Pool) ToPoolOutput

func (i *Pool) ToPoolOutput() PoolOutput

func (*Pool) ToPoolOutputWithContext

func (i *Pool) ToPoolOutputWithContext(ctx context.Context) PoolOutput

type PoolArgs

type PoolArgs struct {
	// Specifies whether a queue should be automatically provisioned for each project collection. Defaults to `false`.
	AutoProvision pulumi.BoolPtrInput
	// Specifies whether or not agents within the pool should be automatically updated. Defaults to `true`.
	AutoUpdate pulumi.BoolPtrInput
	// The name of the agent pool.
	Name pulumi.StringPtrInput
	// Specifies whether the agent pool type is Automation or Deployment. Defaults to `automation`.
	PoolType pulumi.StringPtrInput
}

The set of arguments for constructing a Pool resource.

func (PoolArgs) ElementType

func (PoolArgs) ElementType() reflect.Type

type PoolArray

type PoolArray []PoolInput

func (PoolArray) ElementType

func (PoolArray) ElementType() reflect.Type

func (PoolArray) ToPoolArrayOutput

func (i PoolArray) ToPoolArrayOutput() PoolArrayOutput

func (PoolArray) ToPoolArrayOutputWithContext

func (i PoolArray) ToPoolArrayOutputWithContext(ctx context.Context) PoolArrayOutput

type PoolArrayInput

type PoolArrayInput interface {
	pulumi.Input

	ToPoolArrayOutput() PoolArrayOutput
	ToPoolArrayOutputWithContext(context.Context) PoolArrayOutput
}

PoolArrayInput is an input type that accepts PoolArray and PoolArrayOutput values. You can construct a concrete instance of `PoolArrayInput` via:

PoolArray{ PoolArgs{...} }

type PoolArrayOutput

type PoolArrayOutput struct{ *pulumi.OutputState }

func (PoolArrayOutput) ElementType

func (PoolArrayOutput) ElementType() reflect.Type

func (PoolArrayOutput) Index

func (PoolArrayOutput) ToPoolArrayOutput

func (o PoolArrayOutput) ToPoolArrayOutput() PoolArrayOutput

func (PoolArrayOutput) ToPoolArrayOutputWithContext

func (o PoolArrayOutput) ToPoolArrayOutputWithContext(ctx context.Context) PoolArrayOutput

type PoolInput

type PoolInput interface {
	pulumi.Input

	ToPoolOutput() PoolOutput
	ToPoolOutputWithContext(ctx context.Context) PoolOutput
}

type PoolMap

type PoolMap map[string]PoolInput

func (PoolMap) ElementType

func (PoolMap) ElementType() reflect.Type

func (PoolMap) ToPoolMapOutput

func (i PoolMap) ToPoolMapOutput() PoolMapOutput

func (PoolMap) ToPoolMapOutputWithContext

func (i PoolMap) ToPoolMapOutputWithContext(ctx context.Context) PoolMapOutput

type PoolMapInput

type PoolMapInput interface {
	pulumi.Input

	ToPoolMapOutput() PoolMapOutput
	ToPoolMapOutputWithContext(context.Context) PoolMapOutput
}

PoolMapInput is an input type that accepts PoolMap and PoolMapOutput values. You can construct a concrete instance of `PoolMapInput` via:

PoolMap{ "key": PoolArgs{...} }

type PoolMapOutput

type PoolMapOutput struct{ *pulumi.OutputState }

func (PoolMapOutput) ElementType

func (PoolMapOutput) ElementType() reflect.Type

func (PoolMapOutput) MapIndex

func (PoolMapOutput) ToPoolMapOutput

func (o PoolMapOutput) ToPoolMapOutput() PoolMapOutput

func (PoolMapOutput) ToPoolMapOutputWithContext

func (o PoolMapOutput) ToPoolMapOutputWithContext(ctx context.Context) PoolMapOutput

type PoolOutput

type PoolOutput struct{ *pulumi.OutputState }

func (PoolOutput) AutoProvision added in v2.5.0

func (o PoolOutput) AutoProvision() pulumi.BoolPtrOutput

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

func (PoolOutput) AutoUpdate added in v2.7.0

func (o PoolOutput) AutoUpdate() pulumi.BoolPtrOutput

Specifies whether or not agents within the pool should be automatically updated. Defaults to `true`.

func (PoolOutput) ElementType

func (PoolOutput) ElementType() reflect.Type

func (PoolOutput) Name added in v2.5.0

func (o PoolOutput) Name() pulumi.StringOutput

The name of the agent pool.

func (PoolOutput) PoolType added in v2.5.0

func (o PoolOutput) PoolType() pulumi.StringPtrOutput

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

func (PoolOutput) ToPoolOutput

func (o PoolOutput) ToPoolOutput() PoolOutput

func (PoolOutput) ToPoolOutputWithContext

func (o PoolOutput) ToPoolOutputWithContext(ctx context.Context) PoolOutput

type PoolState

type PoolState struct {
	// Specifies whether a queue should be automatically provisioned for each project collection. Defaults to `false`.
	AutoProvision pulumi.BoolPtrInput
	// Specifies whether or not agents within the pool should be automatically updated. Defaults to `true`.
	AutoUpdate pulumi.BoolPtrInput
	// The name of the agent pool.
	Name pulumi.StringPtrInput
	// Specifies whether the agent pool type is Automation or Deployment. Defaults to `automation`.
	PoolType pulumi.StringPtrInput
}

func (PoolState) ElementType

func (PoolState) ElementType() reflect.Type

type Queue deprecated

type Queue struct {
	pulumi.CustomResourceState

	// The ID of the organization agent pool. Conflicts with `name`.
	//
	// > **NOTE:**
	// One of `name` or `agentPoolId` must be specified, but not both.
	// When `agentPoolId` is specified, the agent queue name will be derived from the agent pool name.
	AgentPoolId pulumi.IntOutput `pulumi:"agentPoolId"`
	// The name of the agent queue. Defaults to the ID of the agent pool. Conflicts with `agentPoolId`.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the project in which to create the resource.
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
}

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

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

## Example Usage

### Creating a Queue from an organization-level pool

<!--Start PulumiCodeChooser --> ```go 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 {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", nil)
		if err != nil {
			return err
		}
		examplePool, err := azuredevops.LookupPool(ctx, &azuredevops.LookupPoolArgs{
			Name: "example-pool",
		}, nil)
		if err != nil {
			return err
		}
		exampleQueue, err := azuredevops.NewQueue(ctx, "exampleQueue", &azuredevops.QueueArgs{
			ProjectId:   exampleProject.ID(),
			AgentPoolId: *pulumi.String(examplePool.Id),
		})
		if err != nil {
			return err
		}
		// Grant access to queue to all pipelines in the project
		_, err = azuredevops.NewResourceAuthorization(ctx, "exampleResourceAuthorization", &azuredevops.ResourceAuthorizationArgs{
			ProjectId:  exampleProject.ID(),
			ResourceId: exampleQueue.ID(),
			Type:       pulumi.String("queue"),
			Authorized: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

### Creating a Queue at the project level (Organization-level permissions not required)

<!--Start PulumiCodeChooser --> ```go 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 {
		exampleProject, err := azuredevops.LookupProject(ctx, &azuredevops.LookupProjectArgs{
			Name: pulumi.StringRef("Example Project"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = azuredevops.NewQueue(ctx, "exampleQueue", &azuredevops.QueueArgs{
			ProjectId: *pulumi.String(exampleProject.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Relevant Links

- [Azure DevOps Service REST API 7.0 - Agent Queues](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues?view=azure-devops-rest-7.0)

## Import

Azure DevOps Agent Pools can be imported using the project ID and agent queue ID, e.g.

```sh $ pulumi import azuredevops:Agent/queue:Queue example 00000000-0000-0000-0000-000000000000/0 ```

Deprecated: azuredevops.agent.Queue has been deprecated in favor of azuredevops.Queue

func GetQueue

func GetQueue(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueueState, opts ...pulumi.ResourceOption) (*Queue, error)

GetQueue gets an existing Queue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewQueue

func NewQueue(ctx *pulumi.Context,
	name string, args *QueueArgs, opts ...pulumi.ResourceOption) (*Queue, error)

NewQueue registers a new resource with the given unique name, arguments, and options.

func (*Queue) ElementType

func (*Queue) ElementType() reflect.Type

func (*Queue) ToQueueOutput

func (i *Queue) ToQueueOutput() QueueOutput

func (*Queue) ToQueueOutputWithContext

func (i *Queue) ToQueueOutputWithContext(ctx context.Context) QueueOutput

type QueueArgs

type QueueArgs struct {
	// The ID of the organization agent pool. Conflicts with `name`.
	//
	// > **NOTE:**
	// One of `name` or `agentPoolId` must be specified, but not both.
	// When `agentPoolId` is specified, the agent queue name will be derived from the agent pool name.
	AgentPoolId pulumi.IntPtrInput
	// The name of the agent queue. Defaults to the ID of the agent pool. Conflicts with `agentPoolId`.
	Name pulumi.StringPtrInput
	// The ID of the project in which to create the resource.
	ProjectId pulumi.StringInput
}

The set of arguments for constructing a Queue resource.

func (QueueArgs) ElementType

func (QueueArgs) ElementType() reflect.Type

type QueueArray

type QueueArray []QueueInput

func (QueueArray) ElementType

func (QueueArray) ElementType() reflect.Type

func (QueueArray) ToQueueArrayOutput

func (i QueueArray) ToQueueArrayOutput() QueueArrayOutput

func (QueueArray) ToQueueArrayOutputWithContext

func (i QueueArray) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueArrayInput

type QueueArrayInput interface {
	pulumi.Input

	ToQueueArrayOutput() QueueArrayOutput
	ToQueueArrayOutputWithContext(context.Context) QueueArrayOutput
}

QueueArrayInput is an input type that accepts QueueArray and QueueArrayOutput values. You can construct a concrete instance of `QueueArrayInput` via:

QueueArray{ QueueArgs{...} }

type QueueArrayOutput

type QueueArrayOutput struct{ *pulumi.OutputState }

func (QueueArrayOutput) ElementType

func (QueueArrayOutput) ElementType() reflect.Type

func (QueueArrayOutput) Index

func (QueueArrayOutput) ToQueueArrayOutput

func (o QueueArrayOutput) ToQueueArrayOutput() QueueArrayOutput

func (QueueArrayOutput) ToQueueArrayOutputWithContext

func (o QueueArrayOutput) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueInput

type QueueInput interface {
	pulumi.Input

	ToQueueOutput() QueueOutput
	ToQueueOutputWithContext(ctx context.Context) QueueOutput
}

type QueueMap

type QueueMap map[string]QueueInput

func (QueueMap) ElementType

func (QueueMap) ElementType() reflect.Type

func (QueueMap) ToQueueMapOutput

func (i QueueMap) ToQueueMapOutput() QueueMapOutput

func (QueueMap) ToQueueMapOutputWithContext

func (i QueueMap) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueMapInput

type QueueMapInput interface {
	pulumi.Input

	ToQueueMapOutput() QueueMapOutput
	ToQueueMapOutputWithContext(context.Context) QueueMapOutput
}

QueueMapInput is an input type that accepts QueueMap and QueueMapOutput values. You can construct a concrete instance of `QueueMapInput` via:

QueueMap{ "key": QueueArgs{...} }

type QueueMapOutput

type QueueMapOutput struct{ *pulumi.OutputState }

func (QueueMapOutput) ElementType

func (QueueMapOutput) ElementType() reflect.Type

func (QueueMapOutput) MapIndex

func (QueueMapOutput) ToQueueMapOutput

func (o QueueMapOutput) ToQueueMapOutput() QueueMapOutput

func (QueueMapOutput) ToQueueMapOutputWithContext

func (o QueueMapOutput) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueOutput

type QueueOutput struct{ *pulumi.OutputState }

func (QueueOutput) AgentPoolId added in v2.5.0

func (o QueueOutput) AgentPoolId() pulumi.IntOutput

The ID of the organization agent pool. Conflicts with `name`.

> **NOTE:** One of `name` or `agentPoolId` must be specified, but not both. When `agentPoolId` is specified, the agent queue name will be derived from the agent pool name.

func (QueueOutput) ElementType

func (QueueOutput) ElementType() reflect.Type

func (QueueOutput) Name added in v2.15.0

func (o QueueOutput) Name() pulumi.StringOutput

The name of the agent queue. Defaults to the ID of the agent pool. Conflicts with `agentPoolId`.

func (QueueOutput) ProjectId added in v2.5.0

func (o QueueOutput) ProjectId() pulumi.StringOutput

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

func (QueueOutput) ToQueueOutput

func (o QueueOutput) ToQueueOutput() QueueOutput

func (QueueOutput) ToQueueOutputWithContext

func (o QueueOutput) ToQueueOutputWithContext(ctx context.Context) QueueOutput

type QueueState

type QueueState struct {
	// The ID of the organization agent pool. Conflicts with `name`.
	//
	// > **NOTE:**
	// One of `name` or `agentPoolId` must be specified, but not both.
	// When `agentPoolId` is specified, the agent queue name will be derived from the agent pool name.
	AgentPoolId pulumi.IntPtrInput
	// The name of the agent queue. Defaults to the ID of the agent pool. Conflicts with `agentPoolId`.
	Name pulumi.StringPtrInput
	// The ID of the project in which to create the resource.
	ProjectId pulumi.StringPtrInput
}

func (QueueState) ElementType

func (QueueState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL