1. Docs
  2. Reference
  3. API
  4. @pulumi/azuredevops
  5. types
  6. output

Module types/output

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.

namespace Agent

namespace Build

namespace Core

namespace Identities

namespace Pipeline

namespace Policy

namespace Repository

namespace ServiceEndpoint

namespace Agent

interface GetPoolsAgentPool

interface GetPoolsAgentPool

property autoProvision

autoProvision: boolean;

property id

id: number;

property name

name: string;

property poolType

poolType: string;

namespace Build

interface BuildDefinitionCiTrigger

interface BuildDefinitionCiTrigger

property override

override?: outputs.Build.BuildDefinitionCiTriggerOverride;

Override the azure-pipeline file and use a this configuration for all builds.

property useYaml

useYaml?: undefined | false | true;

Use the azure-pipeline file for the build configuration. Defaults to false.

interface BuildDefinitionCiTriggerOverride

interface BuildDefinitionCiTriggerOverride

property batch

batch?: undefined | false | true;

If you set batch to true, when a pipeline is running, the system waits until the run is completed, then starts another run with all changes that have not yet been built. Defaults to true.

property branchFilters

branchFilters?: BuildDefinitionCiTriggerOverrideBranchFilter[];

The branches to include and exclude from the trigger.

property maxConcurrentBuildsPerBranch

maxConcurrentBuildsPerBranch?: undefined | number;

The number of max builds per branch. Defaults to 1.

property pathFilters

pathFilters?: BuildDefinitionCiTriggerOverridePathFilter[];

Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.

property pollingInterval

pollingInterval?: undefined | number;

How often the external repository is polled. Defaults to 0.

property pollingJobId

pollingJobId: string;

This is the ID of the polling job that polls the external repository. Once the build definition is saved/updated, this value is set.

interface BuildDefinitionCiTriggerOverrideBranchFilter

interface BuildDefinitionCiTriggerOverrideBranchFilter

property excludes

excludes?: string[];

List of branch patterns to exclude.

property includes

includes?: string[];

List of branch patterns to include.

interface BuildDefinitionCiTriggerOverridePathFilter

interface BuildDefinitionCiTriggerOverridePathFilter

property excludes

excludes?: string[];

List of branch patterns to exclude.

property includes

includes?: string[];

List of branch patterns to include.

interface BuildDefinitionPullRequestTrigger

interface BuildDefinitionPullRequestTrigger

property commentRequired

commentRequired?: undefined | string;

property forks

forks: BuildDefinitionPullRequestTriggerForks;

Set permissions for Forked repositories.

property initialBranch

initialBranch?: undefined | string;

property override

override?: outputs.Build.BuildDefinitionPullRequestTriggerOverride;

Override the azure-pipeline file and use a this configuration for all builds.

property useYaml

useYaml?: undefined | false | true;

Use the azure-pipeline file for the build configuration. Defaults to false.

interface BuildDefinitionPullRequestTriggerForks

interface BuildDefinitionPullRequestTriggerForks

property enabled

enabled: boolean;

Build pull requests form forms of this repository.

property shareSecrets

shareSecrets: boolean;

Make secrets available to builds of forks.

interface BuildDefinitionPullRequestTriggerOverride

interface BuildDefinitionPullRequestTriggerOverride

property autoCancel

autoCancel?: undefined | false | true;

. Defaults to true.

property branchFilters

branchFilters?: BuildDefinitionPullRequestTriggerOverrideBranchFilter[];

The branches to include and exclude from the trigger.

property pathFilters

pathFilters?: BuildDefinitionPullRequestTriggerOverridePathFilter[];

Specify file paths to include or exclude. Note that the wildcard syntax is different between branches/tags and file paths.

interface BuildDefinitionPullRequestTriggerOverrideBranchFilter

interface BuildDefinitionPullRequestTriggerOverrideBranchFilter

property excludes

excludes?: string[];

List of branch patterns to exclude.

property includes

includes?: string[];

List of branch patterns to include.

interface BuildDefinitionPullRequestTriggerOverridePathFilter

interface BuildDefinitionPullRequestTriggerOverridePathFilter

property excludes

excludes?: string[];

List of branch patterns to exclude.

property includes

includes?: string[];

List of branch patterns to include.

interface BuildDefinitionRepository

interface BuildDefinitionRepository

property branchName

branchName?: undefined | string;

The branch name for which builds are triggered. Defaults to master.

property repoId

repoId: string;

The id of the repository. For TfsGit repos, this is simply the ID of the repository. For Github repos, this will take the form of <GitHub Org>/<Repo Name>. For Bitbucket repos, this will take the form of <Workspace ID>/<Repo Name>.

property repoType

repoType: string;

The repository type. Valid values: GitHub or TfsGit or Bitbucket. Defaults to Github.

property serviceConnectionId

serviceConnectionId?: undefined | string;

The service connection ID. Used if the repoType is GitHub.

property ymlPath

ymlPath: string;

The path of the Yaml file describing the build definition.

interface BuildDefinitionVariable

interface BuildDefinitionVariable

property allowOverride

allowOverride?: undefined | false | true;

True if the variable can be overridden. Defaults to true.

property isSecret

isSecret?: undefined | false | true;

True if the variable is a secret. Defaults to false.

property name

name: string;

The name of the variable.

property secretValue

secretValue?: undefined | string;

The secret value of the variable. Used when isSecret set to true.

property value

value?: undefined | string;

The value of the variable.

namespace Core

interface GetProjectsProject

interface GetProjectsProject

property name

name: string;

property projectId

projectId: string;

property projectUrl

projectUrl: string;

property state

state: string;

namespace Identities

interface GetUsersUser

interface GetUsersUser

property descriptor

descriptor: string;

property displayName

displayName: string;

property mailAddress

mailAddress: string;

property origin

origin: string;

property originId

originId?: undefined | string;

property principalName

principalName: string;

namespace Pipeline

interface VariableGroupKeyVault

interface VariableGroupKeyVault

property name

name: string;

The name of the Variable Group.

property serviceEndpointId

serviceEndpointId: string;

interface VariableGroupVariable

interface VariableGroupVariable

property contentType

contentType: string;

property enabled

enabled: boolean;

property expires

expires: string;

property isSecret

isSecret?: undefined | false | true;

A boolean flag describing if the variable value is sensitive. Defaults to false.

property name

name: string;

The key value used for the variable. Must be unique within the Variable Group.

property secretValue

secretValue?: undefined | string;

The secret value of the variable. If omitted, it will default to empty string. Used when isSecret set to true.

property value

value?: undefined | string;

The value of the variable. If omitted, it will default to empty string.

namespace Policy

interface BranchPolicyBuildValidationSettings

interface BranchPolicyBuildValidationSettings

property buildDefinitionId

buildDefinitionId: number;

The ID of the build to monitor for the policy.

property displayName

displayName: string;

The display name for the policy.

property manualQueueOnly

manualQueueOnly?: undefined | false | true;

If set to true, the build will need to be manually queued. Defaults to false

property queueOnSourceUpdateOnly

queueOnSourceUpdateOnly?: undefined | false | true;

True if the build should queue on source updates only. Defaults to true.

property scopes

scopes: BranchPolicyBuildValidationSettingsScope[];

Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

property validDuration

validDuration?: undefined | number;

The number of minutes for which the build is valid. If 0, the build will not expire. Defaults to 720 (12 hours).

interface BranchPolicyBuildValidationSettingsScope

interface BranchPolicyBuildValidationSettingsScope

property matchType

matchType?: undefined | string;

The match type to use when applying the policy. Supported values are Exact (default) or Prefix.

property repositoryId

repositoryId?: undefined | string;

The repository ID. Needed only if the scope of the policy will be limited to a single repository.

property repositoryRef

repositoryRef?: undefined | string;

The ref pattern to use for the match. If matchType is Exact, this should be a qualified ref such as refs/heads/master. If matchType is Prefix, this should be a ref path such as refs/heads/releases.

interface BranchPolicyMinReviewersSettings

interface BranchPolicyMinReviewersSettings

property reviewerCount

reviewerCount: number;

The number of reviewrs needed to approve.

property scopes

scopes: BranchPolicyMinReviewersSettingsScope[];

Controls which repositories and branches the policy will be enabled for. This block must be defined at least once.

property submitterCanVote

submitterCanVote?: undefined | false | true;

Controls whether or not the submitter’s vote counts. Defaults to false.

interface BranchPolicyMinReviewersSettingsScope

interface BranchPolicyMinReviewersSettingsScope

property matchType

matchType?: undefined | string;

The match type to use when applying the policy. Supported values are Exact (default) or Prefix.

property repositoryId

repositoryId?: undefined | string;

The repository ID. Needed only if the scope of the policy will be limited to a single repository.

property repositoryRef

repositoryRef?: undefined | string;

The ref pattern to use for the match. If matchType is Exact, this should be a qualified ref such as refs/heads/master. If matchType is Prefix, this should be a ref path such as refs/heads/releases.

namespace Repository

interface GetRepositoriesRepository

interface GetRepositoriesRepository

property defaultBranch

defaultBranch: string;

property id

id: string;

property name

name: string;

property projectId

projectId: string;

property remoteUrl

remoteUrl: string;

property size

size: number;

property sshUrl

sshUrl: string;

property url

url: string;

property webUrl

webUrl: string;

interface GitInitialization

interface GitInitialization

property initType

initType: string;

The type of repository to create. Valid values: Uninitialized, Clean, or Import. Defaults to Uninitialized.

property sourceType

sourceType?: undefined | string;

Type type of the source repository. Used if the initType is Import.

property sourceUrl

sourceUrl?: undefined | string;

The URL of the source repository. Used if the initType is Import.

namespace ServiceEndpoint

interface AzureRMCredentials

interface AzureRMCredentials

property serviceprincipalid

serviceprincipalid: string;

The service principal application Id

property serviceprincipalkey

serviceprincipalkey: string;

The service principal secret.

property serviceprincipalkeyHash

serviceprincipalkeyHash: string;

interface GitHubAuthOauth

interface GitHubAuthOauth

property oauthConfigurationId

oauthConfigurationId: string;

interface GitHubAuthPersonal

interface GitHubAuthPersonal

property personalAccessToken

personalAccessToken: string;

The Personal Access Token for Github.

property personalAccessTokenHash

personalAccessTokenHash: string;

interface KubernetesAzureSubscription

interface KubernetesAzureSubscription

property azureEnvironment

azureEnvironment?: undefined | string;

Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.

property clusterName

clusterName: string;

The name of the Kubernetes cluster.

property namespace

namespace?: undefined | string;

The Kubernetes namespace. Default value is “default”.

property resourcegroupId

resourcegroupId: string;

The resource group id, to which the Kubernetes cluster is deployed.

property subscriptionId

subscriptionId: string;

The id of the Azure subscription.

property subscriptionName

subscriptionName: string;

The name of the Azure subscription.

property tenantId

tenantId: string;

The id of the tenant used by the subscription.

interface KubernetesKubeconfig

interface KubernetesKubeconfig

property acceptUntrustedCerts

acceptUntrustedCerts?: undefined | false | true;

Set this option to allow clients to accept a self-signed certificate.

property clusterContext

clusterContext?: undefined | string;

Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.

property kubeConfig

kubeConfig: string;

The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.

property kubeConfigHash

kubeConfigHash: string;

interface KubernetesServiceAccount

interface KubernetesServiceAccount

property caCert

caCert: string;

The certificate from a Kubernetes secret object.

property caCertHash

caCertHash: string;

property token

token: string;

The token from a Kubernetes secret object.

property tokenHash

tokenHash: string;