This page documents the language specification for the azuredevops package. If you're looking for help working with the inputs, outputs, or functions of azuredevops resources in a Pulumi program, please see the resource documentation for examples and API reference.
core¶
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.core.AwaitableGetClientConfigResult(id=None, organization_url=None)¶
- class
pulumi_azuredevops.core.AwaitableGetProjectResult(description=None, features=None, id=None, process_template_id=None, project_name=None, version_control=None, visibility=None, work_item_template=None)¶
- class
pulumi_azuredevops.core.AwaitableGetProjectsResult(id=None, project_name=None, projects=None, state=None)¶
- class
pulumi_azuredevops.core.GetClientConfigResult(id=None, organization_url=None)¶ A collection of values returned by getClientConfig.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_azuredevops.core.GetProjectResult(description=None, features=None, id=None, process_template_id=None, project_name=None, version_control=None, visibility=None, work_item_template=None)¶ A collection of values returned by getProject.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_azuredevops.core.GetProjectsResult(id=None, project_name=None, projects=None, state=None)¶ A collection of values returned by getProjects.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_azuredevops.core.Project(resource_name, opts=None, description=None, features=None, project_name=None, version_control=None, visibility=None, work_item_template=None, __props__=None, __name__=None, __opts__=None)¶ Manages a project within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", description="Test Project Description", features={ "artifacts": "disabled", "testplans": "disabled", }, project_name="Test Project", version_control="Git", visibility="private", work_item_template="Agile")
Project & Team: Read, Write, & Manage
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The Description of the Project.
features (pulumi.Input[dict]) – Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifactsproject_name (pulumi.Input[str]) – The Project Name.
version_control (pulumi.Input[str]) – Specifies the version control system. Valid values:
GitorTfvc. Defaults toGit.visibility (pulumi.Input[str]) – Specifies the visibility of the Project. Valid values:
privateorpublic. Defaults toprivate.work_item_template (pulumi.Input[str]) – Specifies the work item template. Defaults to
Agile.
description: pulumi.Output[str] = None¶The Description of the Project.
features: pulumi.Output[dict] = None¶Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifacts
process_template_id: pulumi.Output[str] = None¶The Process Template ID used by the Project.
project_name: pulumi.Output[str] = None¶The Project Name.
version_control: pulumi.Output[str] = None¶Specifies the version control system. Valid values:
GitorTfvc. Defaults toGit.
visibility: pulumi.Output[str] = None¶Specifies the visibility of the Project. Valid values:
privateorpublic. Defaults toprivate.
work_item_template: pulumi.Output[str] = None¶Specifies the work item template. Defaults to
Agile.
- static
get(resource_name, id, opts=None, description=None, features=None, process_template_id=None, project_name=None, version_control=None, visibility=None, work_item_template=None)¶ Get an existing Project 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.
description (pulumi.Input[str]) – The Description of the Project.
features (pulumi.Input[dict]) – Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifactsprocess_template_id (pulumi.Input[str]) – The Process Template ID used by the Project.
project_name (pulumi.Input[str]) – The Project Name.
version_control (pulumi.Input[str]) – Specifies the version control system. Valid values:
GitorTfvc. Defaults toGit.visibility (pulumi.Input[str]) – Specifies the visibility of the Project. Valid values:
privateorpublic. Defaults toprivate.work_item_template (pulumi.Input[str]) – Specifies the work item template. Defaults to
Agile.
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.core.ProjectFeatures(resource_name, opts=None, features=None, project_id=None, __props__=None, __name__=None, __opts__=None)¶ Manages features for Azure DevOps projects
import pulumi import pulumi_azuredevops as azuredevops tf_project_test_001 = azuredevops.Core.get_project(project_name="Test Project") my_project_features = azuredevops.core.ProjectFeatures("my-project-features", project_id=tf_project_test_001.id, features={ "testplans": "disabled", "artifacts": "enabled", })
No official documentation available
Project & Team: Read, Write, & Manage
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
features (pulumi.Input[dict]) – Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifacts
features: pulumi.Output[dict] = None¶Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifacts
- static
get(resource_name, id, opts=None, features=None, project_id=None)¶ Get an existing ProjectFeatures 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.
features (pulumi.Input[dict]) – Defines the status (
enabled,disabled) of the project features.
Valid featuresboards,repositories,pipelines,testplans,artifacts
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.core.get_client_config(opts=None)¶Use this data source to access information about the Azure DevOps organization configured for the provider.
import pulumi import pulumi_azuredevops as azuredevops client_config = azuredevops.Core.get_client_config() pulumi.export("orgUrl", client_config.organization_url)
pulumi_azuredevops.core.get_project(project_name=None, opts=None)¶Use this data source to access information about an existing Project within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.Core.get_project(project_name="Sample Project") pulumi.export("id", project.id) pulumi.export("projectName", project.project_name) pulumi.export("visibility", project.visibility) pulumi.export("versionControl", project.version_control) pulumi.export("workItemTemplate", project.work_item_template) pulumi.export("processTemplateId", project.process_template_id)
pulumi_azuredevops.core.get_projects(project_name=None, state=None, opts=None)¶Use this data source to access information about existing Projects within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops test = azuredevops.Core.get_projects(project_name="contoso", state="wellFormed") pulumi.export("projectId", [__item["project_id"] for __item in test.projects]) pulumi.export("projectName", [__item["name"] for __item in test.projects]) pulumi.export("projectUrl", [__item["projectUrl"] for __item in test.projects]) pulumi.export("state", [__item["state"] for __item in test.projects])