Azure DevOps v2.7.0, Mar 27 23
Azure DevOps v2.7.0, Mar 27 23
azuredevops.ProjectPipelineSettings
Explore with Pulumi AI
Manages Pipeline Settings for Azure DevOps projects
Relevant Links
No official documentation available
PAT Permissions Required
- Full Access
Example Usage
using System.Collections.Generic;
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 exampleProjectPipelineSettings = new AzureDevOps.ProjectPipelineSettings("exampleProjectPipelineSettings", new()
{
ProjectId = exampleProject.Id,
EnforceJobScope = true,
EnforceReferencedRepoScopedToken = false,
EnforceSettableVar = true,
PublishPipelineMetadata = false,
StatusBadgesArePrivate = true,
});
});
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", &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
}
_, err = azuredevops.NewProjectPipelineSettings(ctx, "exampleProjectPipelineSettings", &azuredevops.ProjectPipelineSettingsArgs{
ProjectId: exampleProject.ID(),
EnforceJobScope: pulumi.Bool(true),
EnforceReferencedRepoScopedToken: pulumi.Bool(false),
EnforceSettableVar: pulumi.Bool(true),
PublishPipelineMetadata: pulumi.Bool(false),
StatusBadgesArePrivate: pulumi.Bool(true),
})
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.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ProjectPipelineSettings;
import com.pulumi.azuredevops.ProjectPipelineSettingsArgs;
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 exampleProjectPipelineSettings = new ProjectPipelineSettings("exampleProjectPipelineSettings", ProjectPipelineSettingsArgs.builder()
.projectId(exampleProject.id())
.enforceJobScope(true)
.enforceReferencedRepoScopedToken(false)
.enforceSettableVar(true)
.publishPipelineMetadata(false)
.statusBadgesArePrivate(true)
.build());
}
}
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_project_pipeline_settings = azuredevops.ProjectPipelineSettings("exampleProjectPipelineSettings",
project_id=example_project.id,
enforce_job_scope=True,
enforce_referenced_repo_scoped_token=False,
enforce_settable_var=True,
publish_pipeline_metadata=False,
status_badges_are_private=True)
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 exampleProjectPipelineSettings = new azuredevops.ProjectPipelineSettings("exampleProjectPipelineSettings", {
projectId: exampleProject.id,
enforceJobScope: true,
enforceReferencedRepoScopedToken: false,
enforceSettableVar: true,
publishPipelineMetadata: false,
statusBadgesArePrivate: true,
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleProjectPipelineSettings:
type: azuredevops:ProjectPipelineSettings
properties:
projectId: ${exampleProject.id}
enforceJobScope: true
enforceReferencedRepoScopedToken: false
enforceSettableVar: true
publishPipelineMetadata: false
statusBadgesArePrivate: true
Create ProjectPipelineSettings Resource
new ProjectPipelineSettings(name: string, args: ProjectPipelineSettingsArgs, opts?: CustomResourceOptions);
@overload
def ProjectPipelineSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
enforce_job_scope: Optional[bool] = None,
enforce_referenced_repo_scoped_token: Optional[bool] = None,
enforce_settable_var: Optional[bool] = None,
project_id: Optional[str] = None,
publish_pipeline_metadata: Optional[bool] = None,
status_badges_are_private: Optional[bool] = None)
@overload
def ProjectPipelineSettings(resource_name: str,
args: ProjectPipelineSettingsArgs,
opts: Optional[ResourceOptions] = None)
func NewProjectPipelineSettings(ctx *Context, name string, args ProjectPipelineSettingsArgs, opts ...ResourceOption) (*ProjectPipelineSettings, error)
public ProjectPipelineSettings(string name, ProjectPipelineSettingsArgs args, CustomResourceOptions? opts = null)
public ProjectPipelineSettings(String name, ProjectPipelineSettingsArgs args)
public ProjectPipelineSettings(String name, ProjectPipelineSettingsArgs args, CustomResourceOptions options)
type: azuredevops:ProjectPipelineSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectPipelineSettingsArgs
- 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 ProjectPipelineSettingsArgs
- 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 ProjectPipelineSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectPipelineSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectPipelineSettingsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ProjectPipelineSettings 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 ProjectPipelineSettings resource accepts the following input properties:
- Project
Id string The
id
of the project for which the project pipeline settings will be managed.- Enforce
Job boolScope Limit job authorization scope to current project for non-release pipelines.
- Enforce
Referenced boolRepo Scoped Token Protect access to repositories in YAML pipelines.
- Enforce
Settable boolVar Limit variables that can be set at queue time.
- Publish
Pipeline boolMetadata Publish metadata from pipelines.
- Status
Badges boolAre Private Disable anonymous access to badges.
- Project
Id string The
id
of the project for which the project pipeline settings will be managed.- Enforce
Job boolScope Limit job authorization scope to current project for non-release pipelines.
- Enforce
Referenced boolRepo Scoped Token Protect access to repositories in YAML pipelines.
- Enforce
Settable boolVar Limit variables that can be set at queue time.
- Publish
Pipeline boolMetadata Publish metadata from pipelines.
- Status
Badges boolAre Private Disable anonymous access to badges.
- project
Id String The
id
of the project for which the project pipeline settings will be managed.- enforce
Job BooleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced BooleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable BooleanVar Limit variables that can be set at queue time.
- publish
Pipeline BooleanMetadata Publish metadata from pipelines.
- status
Badges BooleanAre Private Disable anonymous access to badges.
- project
Id string The
id
of the project for which the project pipeline settings will be managed.- enforce
Job booleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced booleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable booleanVar Limit variables that can be set at queue time.
- publish
Pipeline booleanMetadata Publish metadata from pipelines.
- status
Badges booleanAre Private Disable anonymous access to badges.
- project_
id str The
id
of the project for which the project pipeline settings will be managed.- enforce_
job_ boolscope Limit job authorization scope to current project for non-release pipelines.
- enforce_
referenced_ boolrepo_ scoped_ token Protect access to repositories in YAML pipelines.
- enforce_
settable_ boolvar Limit variables that can be set at queue time.
- publish_
pipeline_ boolmetadata Publish metadata from pipelines.
- status_
badges_ boolare_ private Disable anonymous access to badges.
- project
Id String The
id
of the project for which the project pipeline settings will be managed.- enforce
Job BooleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced BooleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable BooleanVar Limit variables that can be set at queue time.
- publish
Pipeline BooleanMetadata Publish metadata from pipelines.
- status
Badges BooleanAre Private Disable anonymous access to badges.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProjectPipelineSettings 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 ProjectPipelineSettings Resource
Get an existing ProjectPipelineSettings 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?: ProjectPipelineSettingsState, opts?: CustomResourceOptions): ProjectPipelineSettings
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enforce_job_scope: Optional[bool] = None,
enforce_referenced_repo_scoped_token: Optional[bool] = None,
enforce_settable_var: Optional[bool] = None,
project_id: Optional[str] = None,
publish_pipeline_metadata: Optional[bool] = None,
status_badges_are_private: Optional[bool] = None) -> ProjectPipelineSettings
func GetProjectPipelineSettings(ctx *Context, name string, id IDInput, state *ProjectPipelineSettingsState, opts ...ResourceOption) (*ProjectPipelineSettings, error)
public static ProjectPipelineSettings Get(string name, Input<string> id, ProjectPipelineSettingsState? state, CustomResourceOptions? opts = null)
public static ProjectPipelineSettings get(String name, Output<String> id, ProjectPipelineSettingsState 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.
- Enforce
Job boolScope Limit job authorization scope to current project for non-release pipelines.
- Enforce
Referenced boolRepo Scoped Token Protect access to repositories in YAML pipelines.
- Enforce
Settable boolVar Limit variables that can be set at queue time.
- Project
Id string The
id
of the project for which the project pipeline settings will be managed.- Publish
Pipeline boolMetadata Publish metadata from pipelines.
- Status
Badges boolAre Private Disable anonymous access to badges.
- Enforce
Job boolScope Limit job authorization scope to current project for non-release pipelines.
- Enforce
Referenced boolRepo Scoped Token Protect access to repositories in YAML pipelines.
- Enforce
Settable boolVar Limit variables that can be set at queue time.
- Project
Id string The
id
of the project for which the project pipeline settings will be managed.- Publish
Pipeline boolMetadata Publish metadata from pipelines.
- Status
Badges boolAre Private Disable anonymous access to badges.
- enforce
Job BooleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced BooleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable BooleanVar Limit variables that can be set at queue time.
- project
Id String The
id
of the project for which the project pipeline settings will be managed.- publish
Pipeline BooleanMetadata Publish metadata from pipelines.
- status
Badges BooleanAre Private Disable anonymous access to badges.
- enforce
Job booleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced booleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable booleanVar Limit variables that can be set at queue time.
- project
Id string The
id
of the project for which the project pipeline settings will be managed.- publish
Pipeline booleanMetadata Publish metadata from pipelines.
- status
Badges booleanAre Private Disable anonymous access to badges.
- enforce_
job_ boolscope Limit job authorization scope to current project for non-release pipelines.
- enforce_
referenced_ boolrepo_ scoped_ token Protect access to repositories in YAML pipelines.
- enforce_
settable_ boolvar Limit variables that can be set at queue time.
- project_
id str The
id
of the project for which the project pipeline settings will be managed.- publish_
pipeline_ boolmetadata Publish metadata from pipelines.
- status_
badges_ boolare_ private Disable anonymous access to badges.
- enforce
Job BooleanScope Limit job authorization scope to current project for non-release pipelines.
- enforce
Referenced BooleanRepo Scoped Token Protect access to repositories in YAML pipelines.
- enforce
Settable BooleanVar Limit variables that can be set at queue time.
- project
Id String The
id
of the project for which the project pipeline settings will be managed.- publish
Pipeline BooleanMetadata Publish metadata from pipelines.
- status
Badges BooleanAre Private Disable anonymous access to badges.
Import
Azure DevOps feature settings can be imported using the project id, e.g.
$ pulumi import azuredevops:index/projectPipelineSettings:ProjectPipelineSettings example 00000000-0000-0000-0000-000000000000
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuredevops
Terraform Provider.