Microsoft.DevHub workflows

Bicep resource definition

The workflows resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevHub/workflows resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevHub/workflows@2025-03-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    artifactGenerationProperties: {
      appName: 'string'
      builderVersion: 'string'
      dockerfileGenerationMode: 'string'
      dockerfileOutputDirectory: 'string'
      generationLanguage: 'string'
      imageName: 'string'
      imageTag: 'string'
      languageVersion: 'string'
      manifestGenerationMode: 'string'
      manifestOutputDirectory: 'string'
      manifestType: 'string'
      namespace: 'string'
      port: 'string'
    }
    azurePipelineProfile: {
      acr: 'string'
      armServiceConnection: 'string'
      build: {
        dockerBuildContext: 'string'
        dockerfile: 'string'
      }
      clusterId: 'string'
      deployment: {
        helmChartPath: 'string'
        helmValues: 'string'
        kubeManifestLocations: [
          'string'
        ]
        manifestType: 'string'
        overrides: {
          {customized property}: 'string'
        }
      }
      lastWorkflowRun: {}
      namespace: 'string'
      pullRequest: {}
      repository: {
        adoOrganization: 'string'
        branchName: 'string'
        projectName: 'string'
        repositoryName: 'string'
        repositoryOwner: 'string'
      }
    }
    githubWorkflowProfile: {
      acr: {
        acrRegistryName: 'string'
        acrRepositoryName: 'string'
        acrResourceGroup: 'string'
        acrSubscriptionId: 'string'
      }
      aksResourceId: 'string'
      branchName: 'string'
      deploymentProperties: {
        helmChartPath: 'string'
        helmValues: 'string'
        kubeManifestLocations: [
          'string'
        ]
        manifestType: 'string'
        overrides: {
          {customized property}: 'string'
        }
      }
      dockerBuildContext: 'string'
      dockerfile: 'string'
      lastWorkflowRun: {}
      namespace: 'string'
      oidcCredentials: {
        azureClientId: 'string'
        azureTenantId: 'string'
      }
      repositoryName: 'string'
      repositoryOwner: 'string'
    }
    templateWorkflowProfile: {
      adoProviderProfile: {
        armServiceConnection: 'string'
        repository: {
          adoOrganization: 'string'
          branchName: 'string'
          projectName: 'string'
          repositoryName: 'string'
          repositoryOwner: 'string'
        }
      }
      deploymentTemplate: {
        destination: 'string'
        parameters: {
          {customized property}: 'string'
        }
        templateId: 'string'
      }
      dockerfileTemplate: {
        destination: 'string'
        parameters: {
          {customized property}: 'string'
        }
        templateId: 'string'
      }
      gitHubProviderProfile: {
        oidcCredentials: {
          azureClientId: 'string'
          azureTenantId: 'string'
        }
        repository: {
          branchName: 'string'
          repositoryName: 'string'
          repositoryOwner: 'string'
        }
      }
      lastWorkflowRun: {}
      manifestTemplates: [
        {
          destination: 'string'
          parameters: {
            {customized property}: 'string'
          }
          templateId: 'string'
        }
      ]
      pullRequest: {}
      repositoryProvider: 'string'
      workflowTemplate: {
        destination: 'string'
        parameters: {
          {customized property}: 'string'
        }
        templateId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevHub/workflows

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Properties of a workflow.	WorkflowProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ACR

Name	Description	Value
acrRegistryName	ACR registry	string
acrRepositoryName	ACR repository	string
acrResourceGroup	ACR resource group	string
acrSubscriptionId	ACR subscription id	string

ADOProviderProfile

Name	Description	Value
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
repository	Details of the ADO repository associated with the workflow.	ADORepository

ADORepository

Name	Description	Value
adoOrganization	The name of the Azure DevOps organization the pipeline is associated with.	string
branchName	The name of the branch the workflow is associated with.	string
projectName	The name of the project the pipeline is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

ArtifactGenerationProperties

Name	Description	Value
appName	The name of the app.	string
builderVersion	The version of the language image used for building the code in the generated dockerfile.	string
dockerfileGenerationMode	The mode of generation to be used for generating Dockerfiles.	'disabled' 'enabled'
dockerfileOutputDirectory	The directory to output the generated Dockerfile to.	string
generationLanguage	The programming language used.	'clojure' 'csharp' 'erlang' 'go' 'gomodule' 'gradle' 'java' 'javascript' 'php' 'python' 'ruby' 'rust' 'swift'
imageName	The name of the image to be generated.	string
imageTag	The tag to apply to the generated image.	string
languageVersion	The version of the language image used for execution in the generated dockerfile.	string
manifestGenerationMode	The mode of generation to be used for generating Manifest.	'disabled' 'enabled'
manifestOutputDirectory	The directory to output the generated manifests to.	string
manifestType	Determines the type of manifests to be generated.	'helm' 'kube'
namespace	The namespace to deploy the application to.	string
port	The port the application is exposed on.	string

AzurePipelineProfile

Name	Description	Value
acr	Resource identifier for azure container registry repository associated with the workflow.	string
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
build	Build details of the repository associated with the workflow.	Build
clusterId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
deployment	Deployment details of the repository associated with the workflow.	Deployment
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
pullRequest	Details of the pull request containing the workflow.	PullRequest
repository	Details of the ADO repository associated with the workflow.	ADORepository

Build

Name	Description	Value
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string

Deployment

Name	Description	Value
helmChartPath	Helm chart directory path in repository.	string
helmValues	Helm Values.yaml file location in repository.	string
kubeManifestLocations		string[]
manifestType	Determines the type of manifests within the repository.	'helm' 'kube' 'kustomize'
overrides	Manifest override values.	DeploymentOverrides

DeploymentOverrides

Name	Description	Value

GitHubProviderProfile

Name	Description	Value
oidcCredentials	The fields needed for OIDC with GitHub.	OidcCredentials
repository	Details of the GitHub repository associated with the workflow.	GitHubRepository

GitHubRepository

Name	Description	Value
branchName	The name of the branch the workflow is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

GitHubWorkflowProfile

Name	Description	Value
acr	Information on the azure container registry	ACR
aksResourceId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
branchName	Repository Branch Name	string
deploymentProperties	Deployment details of the repository associated with the workflow.	Deployment
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
oidcCredentials	The fields needed for OIDC with GitHub.	GitHubWorkflowProfileOidcCredentials
repositoryName	Repository Name	string
repositoryOwner	Repository Owner	string

GitHubWorkflowProfileOidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

OidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

PullRequest

Name	Description	Value

TemplateReference

Name	Description	Value
destination	destination for template creation	string
parameters	parameters for template creation	TemplateReferenceParameters
templateId	The versioned template arm resource id.	string

TemplateReferenceParameters

Name	Description	Value

TemplateWorkflowProfile

Name	Description	Value
adoProviderProfile	Details of the GitHub repository associated with the workflow.	ADOProviderProfile
deploymentTemplate	The properties of ADO OAuth.	TemplateReference
dockerfileTemplate	The properties of ADO OAuth.	TemplateReference
gitHubProviderProfile	Details of the GitHub repository and credentials associated with the workflow.	GitHubProviderProfile
lastWorkflowRun		WorkflowRun
manifestTemplates		TemplateReference[]
pullRequest	Details of the pull request containing the workflow.	PullRequest
repositoryProvider	The status of the Pull Request submitted against the users repository.	'ado' 'github'
workflowTemplate	The properties of ADO OAuth.	TemplateReference

TrackedResourceTags

Name	Description	Value

WorkflowProperties

Name	Description	Value
artifactGenerationProperties	Properties for generating artifacts like dockerfile and manifests.	ArtifactGenerationProperties
azurePipelineProfile	Profile of an azure pipeline.	AzurePipelineProfile
githubWorkflowProfile	Profile of a github workflow.	GitHubWorkflowProfile
templateWorkflowProfile	Profile of an template workflow.	TemplateWorkflowProfile

WorkflowRun

Name	Description	Value

ARM template resource definition

The workflows resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevHub/workflows resource, add the following JSON to your template.

{
  "type": "Microsoft.DevHub/workflows",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "artifactGenerationProperties": {
      "appName": "string",
      "builderVersion": "string",
      "dockerfileGenerationMode": "string",
      "dockerfileOutputDirectory": "string",
      "generationLanguage": "string",
      "imageName": "string",
      "imageTag": "string",
      "languageVersion": "string",
      "manifestGenerationMode": "string",
      "manifestOutputDirectory": "string",
      "manifestType": "string",
      "namespace": "string",
      "port": "string"
    },
    "azurePipelineProfile": {
      "acr": "string",
      "armServiceConnection": "string",
      "build": {
        "dockerBuildContext": "string",
        "dockerfile": "string"
      },
      "clusterId": "string",
      "deployment": {
        "helmChartPath": "string",
        "helmValues": "string",
        "kubeManifestLocations": [ "string" ],
        "manifestType": "string",
        "overrides": {
          "{customized property}": "string"
        }
      },
      "lastWorkflowRun": {
      },
      "namespace": "string",
      "pullRequest": {
      },
      "repository": {
        "adoOrganization": "string",
        "branchName": "string",
        "projectName": "string",
        "repositoryName": "string",
        "repositoryOwner": "string"
      }
    },
    "githubWorkflowProfile": {
      "acr": {
        "acrRegistryName": "string",
        "acrRepositoryName": "string",
        "acrResourceGroup": "string",
        "acrSubscriptionId": "string"
      },
      "aksResourceId": "string",
      "branchName": "string",
      "deploymentProperties": {
        "helmChartPath": "string",
        "helmValues": "string",
        "kubeManifestLocations": [ "string" ],
        "manifestType": "string",
        "overrides": {
          "{customized property}": "string"
        }
      },
      "dockerBuildContext": "string",
      "dockerfile": "string",
      "lastWorkflowRun": {
      },
      "namespace": "string",
      "oidcCredentials": {
        "azureClientId": "string",
        "azureTenantId": "string"
      },
      "repositoryName": "string",
      "repositoryOwner": "string"
    },
    "templateWorkflowProfile": {
      "adoProviderProfile": {
        "armServiceConnection": "string",
        "repository": {
          "adoOrganization": "string",
          "branchName": "string",
          "projectName": "string",
          "repositoryName": "string",
          "repositoryOwner": "string"
        }
      },
      "deploymentTemplate": {
        "destination": "string",
        "parameters": {
          "{customized property}": "string"
        },
        "templateId": "string"
      },
      "dockerfileTemplate": {
        "destination": "string",
        "parameters": {
          "{customized property}": "string"
        },
        "templateId": "string"
      },
      "gitHubProviderProfile": {
        "oidcCredentials": {
          "azureClientId": "string",
          "azureTenantId": "string"
        },
        "repository": {
          "branchName": "string",
          "repositoryName": "string",
          "repositoryOwner": "string"
        }
      },
      "lastWorkflowRun": {
      },
      "manifestTemplates": [
        {
          "destination": "string",
          "parameters": {
            "{customized property}": "string"
          },
          "templateId": "string"
        }
      ],
      "pullRequest": {
      },
      "repositoryProvider": "string",
      "workflowTemplate": {
        "destination": "string",
        "parameters": {
          "{customized property}": "string"
        },
        "templateId": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevHub/workflows

Name	Description	Value
apiVersion	The api version	'2025-03-01-preview'
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Properties of a workflow.	WorkflowProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DevHub/workflows'

ACR

Name	Description	Value
acrRegistryName	ACR registry	string
acrRepositoryName	ACR repository	string
acrResourceGroup	ACR resource group	string
acrSubscriptionId	ACR subscription id	string

ADOProviderProfile

Name	Description	Value
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
repository	Details of the ADO repository associated with the workflow.	ADORepository

ADORepository

Name	Description	Value
adoOrganization	The name of the Azure DevOps organization the pipeline is associated with.	string
branchName	The name of the branch the workflow is associated with.	string
projectName	The name of the project the pipeline is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

ArtifactGenerationProperties

Name	Description	Value
appName	The name of the app.	string
builderVersion	The version of the language image used for building the code in the generated dockerfile.	string
dockerfileGenerationMode	The mode of generation to be used for generating Dockerfiles.	'disabled' 'enabled'
dockerfileOutputDirectory	The directory to output the generated Dockerfile to.	string
generationLanguage	The programming language used.	'clojure' 'csharp' 'erlang' 'go' 'gomodule' 'gradle' 'java' 'javascript' 'php' 'python' 'ruby' 'rust' 'swift'
imageName	The name of the image to be generated.	string
imageTag	The tag to apply to the generated image.	string
languageVersion	The version of the language image used for execution in the generated dockerfile.	string
manifestGenerationMode	The mode of generation to be used for generating Manifest.	'disabled' 'enabled'
manifestOutputDirectory	The directory to output the generated manifests to.	string
manifestType	Determines the type of manifests to be generated.	'helm' 'kube'
namespace	The namespace to deploy the application to.	string
port	The port the application is exposed on.	string

AzurePipelineProfile

Name	Description	Value
acr	Resource identifier for azure container registry repository associated with the workflow.	string
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
build	Build details of the repository associated with the workflow.	Build
clusterId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
deployment	Deployment details of the repository associated with the workflow.	Deployment
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
pullRequest	Details of the pull request containing the workflow.	PullRequest
repository	Details of the ADO repository associated with the workflow.	ADORepository

Build

Name	Description	Value
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string

Deployment

Name	Description	Value
helmChartPath	Helm chart directory path in repository.	string
helmValues	Helm Values.yaml file location in repository.	string
kubeManifestLocations		string[]
manifestType	Determines the type of manifests within the repository.	'helm' 'kube' 'kustomize'
overrides	Manifest override values.	DeploymentOverrides

DeploymentOverrides

Name	Description	Value

GitHubProviderProfile

Name	Description	Value
oidcCredentials	The fields needed for OIDC with GitHub.	OidcCredentials
repository	Details of the GitHub repository associated with the workflow.	GitHubRepository

GitHubRepository

Name	Description	Value
branchName	The name of the branch the workflow is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

GitHubWorkflowProfile

Name	Description	Value
acr	Information on the azure container registry	ACR
aksResourceId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
branchName	Repository Branch Name	string
deploymentProperties	Deployment details of the repository associated with the workflow.	Deployment
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
oidcCredentials	The fields needed for OIDC with GitHub.	GitHubWorkflowProfileOidcCredentials
repositoryName	Repository Name	string
repositoryOwner	Repository Owner	string

GitHubWorkflowProfileOidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

OidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

PullRequest

Name	Description	Value

TemplateReference

Name	Description	Value
destination	destination for template creation	string
parameters	parameters for template creation	TemplateReferenceParameters
templateId	The versioned template arm resource id.	string

TemplateReferenceParameters

Name	Description	Value

TemplateWorkflowProfile

Name	Description	Value
adoProviderProfile	Details of the GitHub repository associated with the workflow.	ADOProviderProfile
deploymentTemplate	The properties of ADO OAuth.	TemplateReference
dockerfileTemplate	The properties of ADO OAuth.	TemplateReference
gitHubProviderProfile	Details of the GitHub repository and credentials associated with the workflow.	GitHubProviderProfile
lastWorkflowRun		WorkflowRun
manifestTemplates		TemplateReference[]
pullRequest	Details of the pull request containing the workflow.	PullRequest
repositoryProvider	The status of the Pull Request submitted against the users repository.	'ado' 'github'
workflowTemplate	The properties of ADO OAuth.	TemplateReference

TrackedResourceTags

Name	Description	Value

WorkflowProperties

Name	Description	Value
artifactGenerationProperties	Properties for generating artifacts like dockerfile and manifests.	ArtifactGenerationProperties
azurePipelineProfile	Profile of an azure pipeline.	AzurePipelineProfile
githubWorkflowProfile	Profile of a github workflow.	GitHubWorkflowProfile
templateWorkflowProfile	Profile of an template workflow.	TemplateWorkflowProfile

WorkflowRun

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The workflows resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevHub/workflows resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevHub/workflows@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      artifactGenerationProperties = {
        appName = "string"
        builderVersion = "string"
        dockerfileGenerationMode = "string"
        dockerfileOutputDirectory = "string"
        generationLanguage = "string"
        imageName = "string"
        imageTag = "string"
        languageVersion = "string"
        manifestGenerationMode = "string"
        manifestOutputDirectory = "string"
        manifestType = "string"
        namespace = "string"
        port = "string"
      }
      azurePipelineProfile = {
        acr = "string"
        armServiceConnection = "string"
        build = {
          dockerBuildContext = "string"
          dockerfile = "string"
        }
        clusterId = "string"
        deployment = {
          helmChartPath = "string"
          helmValues = "string"
          kubeManifestLocations = [
            "string"
          ]
          manifestType = "string"
          overrides = {
            {customized property} = "string"
          }
        }
        lastWorkflowRun = {
        }
        namespace = "string"
        pullRequest = {
        }
        repository = {
          adoOrganization = "string"
          branchName = "string"
          projectName = "string"
          repositoryName = "string"
          repositoryOwner = "string"
        }
      }
      githubWorkflowProfile = {
        acr = {
          acrRegistryName = "string"
          acrRepositoryName = "string"
          acrResourceGroup = "string"
          acrSubscriptionId = "string"
        }
        aksResourceId = "string"
        branchName = "string"
        deploymentProperties = {
          helmChartPath = "string"
          helmValues = "string"
          kubeManifestLocations = [
            "string"
          ]
          manifestType = "string"
          overrides = {
            {customized property} = "string"
          }
        }
        dockerBuildContext = "string"
        dockerfile = "string"
        lastWorkflowRun = {
        }
        namespace = "string"
        oidcCredentials = {
          azureClientId = "string"
          azureTenantId = "string"
        }
        repositoryName = "string"
        repositoryOwner = "string"
      }
      templateWorkflowProfile = {
        adoProviderProfile = {
          armServiceConnection = "string"
          repository = {
            adoOrganization = "string"
            branchName = "string"
            projectName = "string"
            repositoryName = "string"
            repositoryOwner = "string"
          }
        }
        deploymentTemplate = {
          destination = "string"
          parameters = {
            {customized property} = "string"
          }
          templateId = "string"
        }
        dockerfileTemplate = {
          destination = "string"
          parameters = {
            {customized property} = "string"
          }
          templateId = "string"
        }
        gitHubProviderProfile = {
          oidcCredentials = {
            azureClientId = "string"
            azureTenantId = "string"
          }
          repository = {
            branchName = "string"
            repositoryName = "string"
            repositoryOwner = "string"
          }
        }
        lastWorkflowRun = {
        }
        manifestTemplates = [
          {
            destination = "string"
            parameters = {
              {customized property} = "string"
            }
            templateId = "string"
          }
        ]
        pullRequest = {
        }
        repositoryProvider = "string"
        workflowTemplate = {
          destination = "string"
          parameters = {
            {customized property} = "string"
          }
          templateId = "string"
        }
      }
    }
  }
}

Property Values

Microsoft.DevHub/workflows

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Properties of a workflow.	WorkflowProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DevHub/workflows@2025-03-01-preview"

ACR

Name	Description	Value
acrRegistryName	ACR registry	string
acrRepositoryName	ACR repository	string
acrResourceGroup	ACR resource group	string
acrSubscriptionId	ACR subscription id	string

ADOProviderProfile

Name	Description	Value
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
repository	Details of the ADO repository associated with the workflow.	ADORepository

ADORepository

Name	Description	Value
adoOrganization	The name of the Azure DevOps organization the pipeline is associated with.	string
branchName	The name of the branch the workflow is associated with.	string
projectName	The name of the project the pipeline is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

ArtifactGenerationProperties

Name	Description	Value
appName	The name of the app.	string
builderVersion	The version of the language image used for building the code in the generated dockerfile.	string
dockerfileGenerationMode	The mode of generation to be used for generating Dockerfiles.	'disabled' 'enabled'
dockerfileOutputDirectory	The directory to output the generated Dockerfile to.	string
generationLanguage	The programming language used.	'clojure' 'csharp' 'erlang' 'go' 'gomodule' 'gradle' 'java' 'javascript' 'php' 'python' 'ruby' 'rust' 'swift'
imageName	The name of the image to be generated.	string
imageTag	The tag to apply to the generated image.	string
languageVersion	The version of the language image used for execution in the generated dockerfile.	string
manifestGenerationMode	The mode of generation to be used for generating Manifest.	'disabled' 'enabled'
manifestOutputDirectory	The directory to output the generated manifests to.	string
manifestType	Determines the type of manifests to be generated.	'helm' 'kube'
namespace	The namespace to deploy the application to.	string
port	The port the application is exposed on.	string

AzurePipelineProfile

Name	Description	Value
acr	Resource identifier for azure container registry repository associated with the workflow.	string
armServiceConnection	The name of the ARM Service Connection the pipeline is associated with.	string
build	Build details of the repository associated with the workflow.	Build
clusterId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
deployment	Deployment details of the repository associated with the workflow.	Deployment
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
pullRequest	Details of the pull request containing the workflow.	PullRequest
repository	Details of the ADO repository associated with the workflow.	ADORepository

Build

Name	Description	Value
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string

Deployment

Name	Description	Value
helmChartPath	Helm chart directory path in repository.	string
helmValues	Helm Values.yaml file location in repository.	string
kubeManifestLocations		string[]
manifestType	Determines the type of manifests within the repository.	'helm' 'kube' 'kustomize'
overrides	Manifest override values.	DeploymentOverrides

DeploymentOverrides

Name	Description	Value

GitHubProviderProfile

Name	Description	Value
oidcCredentials	The fields needed for OIDC with GitHub.	OidcCredentials
repository	Details of the GitHub repository associated with the workflow.	GitHubRepository

GitHubRepository

Name	Description	Value
branchName	The name of the branch the workflow is associated with.	string
repositoryName	The name of the repository the workflow is associated with.	string
repositoryOwner	The owner of the repository the workflow is associated with.	string

GitHubWorkflowProfile

Name	Description	Value
acr	Information on the azure container registry	ACR
aksResourceId	The Azure Kubernetes Cluster Resource the application will be deployed to.	string
branchName	Repository Branch Name	string
deploymentProperties	Deployment details of the repository associated with the workflow.	Deployment
dockerBuildContext	Path to Dockerfile Build Context within the repository.	string
dockerfile	Path to the Dockerfile within the repository.	string
lastWorkflowRun		WorkflowRun
namespace	Kubernetes namespace the application is deployed to.	string
oidcCredentials	The fields needed for OIDC with GitHub.	GitHubWorkflowProfileOidcCredentials
repositoryName	Repository Name	string
repositoryOwner	Repository Owner	string

GitHubWorkflowProfileOidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

OidcCredentials

Name	Description	Value
azureClientId	Azure Application Client ID	string
azureTenantId	Azure Directory (tenant) ID	string

PullRequest

Name	Description	Value

TemplateReference

Name	Description	Value
destination	destination for template creation	string
parameters	parameters for template creation	TemplateReferenceParameters
templateId	The versioned template arm resource id.	string

TemplateReferenceParameters

Name	Description	Value

TemplateWorkflowProfile

Name	Description	Value
adoProviderProfile	Details of the GitHub repository associated with the workflow.	ADOProviderProfile
deploymentTemplate	The properties of ADO OAuth.	TemplateReference
dockerfileTemplate	The properties of ADO OAuth.	TemplateReference
gitHubProviderProfile	Details of the GitHub repository and credentials associated with the workflow.	GitHubProviderProfile
lastWorkflowRun		WorkflowRun
manifestTemplates		TemplateReference[]
pullRequest	Details of the pull request containing the workflow.	PullRequest
repositoryProvider	The status of the Pull Request submitted against the users repository.	'ado' 'github'
workflowTemplate	The properties of ADO OAuth.	TemplateReference

TrackedResourceTags

Name	Description	Value

WorkflowProperties

Name	Description	Value
artifactGenerationProperties	Properties for generating artifacts like dockerfile and manifests.	ArtifactGenerationProperties
azurePipelineProfile	Profile of an azure pipeline.	AzurePipelineProfile
githubWorkflowProfile	Profile of a github workflow.	GitHubWorkflowProfile
templateWorkflowProfile	Profile of an template workflow.	TemplateWorkflowProfile

WorkflowRun

Name	Description	Value

Feedback

Was this page helpful?

Last updated on 2025-03-18

Microsoft.DevHub workflows

Bicep resource definition

Resource format

Property Values

Microsoft.DevHub/workflows

ACR

ADOProviderProfile

ADORepository

ArtifactGenerationProperties

AzurePipelineProfile

Build

Deployment

DeploymentOverrides

GitHubProviderProfile

GitHubRepository

GitHubWorkflowProfile

GitHubWorkflowProfileOidcCredentials

OidcCredentials

PullRequest

TemplateReference

TemplateReferenceParameters

TemplateWorkflowProfile

TrackedResourceTags

WorkflowProperties

WorkflowRun

ARM template resource definition

Resource format

Property Values

Microsoft.DevHub/workflows

ACR

ADOProviderProfile

ADORepository

ArtifactGenerationProperties

AzurePipelineProfile

Build

Deployment

DeploymentOverrides

GitHubProviderProfile

GitHubRepository

GitHubWorkflowProfile

GitHubWorkflowProfileOidcCredentials

OidcCredentials

PullRequest

TemplateReference

TemplateReferenceParameters

TemplateWorkflowProfile

TrackedResourceTags

WorkflowProperties

WorkflowRun

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.DevHub/workflows

ACR

ADOProviderProfile

ADORepository

ArtifactGenerationProperties

AzurePipelineProfile

Build

Deployment

DeploymentOverrides

GitHubProviderProfile

GitHubRepository

GitHubWorkflowProfile

GitHubWorkflowProfileOidcCredentials

OidcCredentials

PullRequest

TemplateReference

TemplateReferenceParameters

TemplateWorkflowProfile

TrackedResourceTags

WorkflowProperties

WorkflowRun

Feedback

Additional resources