Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. devhub
  5. getWorkflow
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.devhub.getWorkflow

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Resource representation of a workflow Azure REST API version: 2022-10-11-preview.

Other available API versions: 2023-08-01, 2024-05-01-preview, 2024-08-01-preview.

Using getWorkflow

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkflow(args: GetWorkflowArgs, opts?: InvokeOptions): Promise<GetWorkflowResult>
function getWorkflowOutput(args: GetWorkflowOutputArgs, opts?: InvokeOptions): Output<GetWorkflowResult>
Copy
def get_workflow(resource_group_name: Optional[str] = None,
                 workflow_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetWorkflowResult
def get_workflow_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 workflow_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetWorkflowResult]
Copy
func LookupWorkflow(ctx *Context, args *LookupWorkflowArgs, opts ...InvokeOption) (*LookupWorkflowResult, error)
func LookupWorkflowOutput(ctx *Context, args *LookupWorkflowOutputArgs, opts ...InvokeOption) LookupWorkflowResultOutput
Copy

> Note: This function is named LookupWorkflow in the Go SDK.

public static class GetWorkflow 
{
    public static Task<GetWorkflowResult> InvokeAsync(GetWorkflowArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkflowResult> Invoke(GetWorkflowInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkflowResult> getWorkflow(GetWorkflowArgs args, InvokeOptions options)
public static Output<GetWorkflowResult> getWorkflow(GetWorkflowArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devhub:getWorkflow
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkflowName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workflow resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkflowName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workflow resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workflowName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workflow resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workflowName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workflow resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workflow_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workflow resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workflowName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workflow resource.

getWorkflow Result

The following output properties are available:

AuthStatus string
Determines the authorization status of requests.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrStatus string
The status of the Pull Request submitted against the users repository.
PrURL string
The URL to the Pull Request submitted against the users repository.
PullNumber int
The number associated with the submitted pull request.
SystemData Pulumi.AzureNative.DevHub.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Acr Pulumi.AzureNative.DevHub.Outputs.ACRResponse
Information on the azure container registry
AksResourceId string
The Azure Kubernetes Cluster Resource the application will be deployed to.
AppName string
The name of the app.
BranchName string
Repository Branch Name
BuilderVersion string
The version of the language image used for building the code in the generated dockerfile.
DeploymentProperties Pulumi.AzureNative.DevHub.Outputs.DeploymentPropertiesResponse
DockerBuildContext string
Path to Dockerfile Build Context within the repository.
Dockerfile string
Path to the Dockerfile within the repository.
DockerfileGenerationMode string
The mode of generation to be used for generating Dockerfiles.
DockerfileOutputDirectory string
The directory to output the generated Dockerfile to.
GenerationLanguage string
The programming language used.
ImageName string
The name of the image to be generated.
ImageTag string
The tag to apply to the generated image.
LanguageVersion string
The version of the language image used for execution in the generated dockerfile.
LastWorkflowRun Pulumi.AzureNative.DevHub.Outputs.WorkflowRunResponse
ManifestGenerationMode string
The mode of generation to be used for generating Manifest.
ManifestOutputDirectory string
The directory to output the generated manifests to.
ManifestType string
Determines the type of manifests to be generated.
Namespace string
Kubernetes namespace the application is deployed to.
OidcCredentials Pulumi.AzureNative.DevHub.Outputs.GitHubWorkflowProfileResponseOidcCredentials
The fields needed for OIDC with GitHub.
Port string
The port the application is exposed on.
RepositoryName string
Repository Name
RepositoryOwner string
Repository Owner
Tags Dictionary<string, string>
Resource tags.
AuthStatus string
Determines the authorization status of requests.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrStatus string
The status of the Pull Request submitted against the users repository.
PrURL string
The URL to the Pull Request submitted against the users repository.
PullNumber int
The number associated with the submitted pull request.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Acr ACRResponse
Information on the azure container registry
AksResourceId string
The Azure Kubernetes Cluster Resource the application will be deployed to.
AppName string
The name of the app.
BranchName string
Repository Branch Name
BuilderVersion string
The version of the language image used for building the code in the generated dockerfile.
DeploymentProperties DeploymentPropertiesResponse
DockerBuildContext string
Path to Dockerfile Build Context within the repository.
Dockerfile string
Path to the Dockerfile within the repository.
DockerfileGenerationMode string
The mode of generation to be used for generating Dockerfiles.
DockerfileOutputDirectory string
The directory to output the generated Dockerfile to.
GenerationLanguage string
The programming language used.
ImageName string
The name of the image to be generated.
ImageTag string
The tag to apply to the generated image.
LanguageVersion string
The version of the language image used for execution in the generated dockerfile.
LastWorkflowRun WorkflowRunResponse
ManifestGenerationMode string
The mode of generation to be used for generating Manifest.
ManifestOutputDirectory string
The directory to output the generated manifests to.
ManifestType string
Determines the type of manifests to be generated.
Namespace string
Kubernetes namespace the application is deployed to.
OidcCredentials GitHubWorkflowProfileResponseOidcCredentials
The fields needed for OIDC with GitHub.
Port string
The port the application is exposed on.
RepositoryName string
Repository Name
RepositoryOwner string
Repository Owner
Tags map[string]string
Resource tags.
authStatus String
Determines the authorization status of requests.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
prStatus String
The status of the Pull Request submitted against the users repository.
prURL String
The URL to the Pull Request submitted against the users repository.
pullNumber Integer
The number associated with the submitted pull request.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
acr ACRResponse
Information on the azure container registry
aksResourceId String
The Azure Kubernetes Cluster Resource the application will be deployed to.
appName String
The name of the app.
branchName String
Repository Branch Name
builderVersion String
The version of the language image used for building the code in the generated dockerfile.
deploymentProperties DeploymentPropertiesResponse
dockerBuildContext String
Path to Dockerfile Build Context within the repository.
dockerfile String
Path to the Dockerfile within the repository.
dockerfileGenerationMode String
The mode of generation to be used for generating Dockerfiles.
dockerfileOutputDirectory String
The directory to output the generated Dockerfile to.
generationLanguage String
The programming language used.
imageName String
The name of the image to be generated.
imageTag String
The tag to apply to the generated image.
languageVersion String
The version of the language image used for execution in the generated dockerfile.
lastWorkflowRun WorkflowRunResponse
manifestGenerationMode String
The mode of generation to be used for generating Manifest.
manifestOutputDirectory String
The directory to output the generated manifests to.
manifestType String
Determines the type of manifests to be generated.
namespace String
Kubernetes namespace the application is deployed to.
oidcCredentials GitHubWorkflowProfileResponseOidcCredentials
The fields needed for OIDC with GitHub.
port String
The port the application is exposed on.
repositoryName String
Repository Name
repositoryOwner String
Repository Owner
tags Map<String,String>
Resource tags.
authStatus string
Determines the authorization status of requests.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
prStatus string
The status of the Pull Request submitted against the users repository.
prURL string
The URL to the Pull Request submitted against the users repository.
pullNumber number
The number associated with the submitted pull request.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
acr ACRResponse
Information on the azure container registry
aksResourceId string
The Azure Kubernetes Cluster Resource the application will be deployed to.
appName string
The name of the app.
branchName string
Repository Branch Name
builderVersion string
The version of the language image used for building the code in the generated dockerfile.
deploymentProperties DeploymentPropertiesResponse
dockerBuildContext string
Path to Dockerfile Build Context within the repository.
dockerfile string
Path to the Dockerfile within the repository.
dockerfileGenerationMode string
The mode of generation to be used for generating Dockerfiles.
dockerfileOutputDirectory string
The directory to output the generated Dockerfile to.
generationLanguage string
The programming language used.
imageName string
The name of the image to be generated.
imageTag string
The tag to apply to the generated image.
languageVersion string
The version of the language image used for execution in the generated dockerfile.
lastWorkflowRun WorkflowRunResponse
manifestGenerationMode string
The mode of generation to be used for generating Manifest.
manifestOutputDirectory string
The directory to output the generated manifests to.
manifestType string
Determines the type of manifests to be generated.
namespace string
Kubernetes namespace the application is deployed to.
oidcCredentials GitHubWorkflowProfileResponseOidcCredentials
The fields needed for OIDC with GitHub.
port string
The port the application is exposed on.
repositoryName string
Repository Name
repositoryOwner string
Repository Owner
tags {[key: string]: string}
Resource tags.
auth_status str
Determines the authorization status of requests.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
pr_status str
The status of the Pull Request submitted against the users repository.
pr_url str
The URL to the Pull Request submitted against the users repository.
pull_number int
The number associated with the submitted pull request.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
acr ACRResponse
Information on the azure container registry
aks_resource_id str
The Azure Kubernetes Cluster Resource the application will be deployed to.
app_name str
The name of the app.
branch_name str
Repository Branch Name
builder_version str
The version of the language image used for building the code in the generated dockerfile.
deployment_properties DeploymentPropertiesResponse
docker_build_context str
Path to Dockerfile Build Context within the repository.
dockerfile str
Path to the Dockerfile within the repository.
dockerfile_generation_mode str
The mode of generation to be used for generating Dockerfiles.
dockerfile_output_directory str
The directory to output the generated Dockerfile to.
generation_language str
The programming language used.
image_name str
The name of the image to be generated.
image_tag str
The tag to apply to the generated image.
language_version str
The version of the language image used for execution in the generated dockerfile.
last_workflow_run WorkflowRunResponse
manifest_generation_mode str
The mode of generation to be used for generating Manifest.
manifest_output_directory str
The directory to output the generated manifests to.
manifest_type str
Determines the type of manifests to be generated.
namespace str
Kubernetes namespace the application is deployed to.
oidc_credentials GitHubWorkflowProfileResponseOidcCredentials
The fields needed for OIDC with GitHub.
port str
The port the application is exposed on.
repository_name str
Repository Name
repository_owner str
Repository Owner
tags Mapping[str, str]
Resource tags.
authStatus String
Determines the authorization status of requests.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
prStatus String
The status of the Pull Request submitted against the users repository.
prURL String
The URL to the Pull Request submitted against the users repository.
pullNumber Number
The number associated with the submitted pull request.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
acr Property Map
Information on the azure container registry
aksResourceId String
The Azure Kubernetes Cluster Resource the application will be deployed to.
appName String
The name of the app.
branchName String
Repository Branch Name
builderVersion String
The version of the language image used for building the code in the generated dockerfile.
deploymentProperties Property Map
dockerBuildContext String
Path to Dockerfile Build Context within the repository.
dockerfile String
Path to the Dockerfile within the repository.
dockerfileGenerationMode String
The mode of generation to be used for generating Dockerfiles.
dockerfileOutputDirectory String
The directory to output the generated Dockerfile to.
generationLanguage String
The programming language used.
imageName String
The name of the image to be generated.
imageTag String
The tag to apply to the generated image.
languageVersion String
The version of the language image used for execution in the generated dockerfile.
lastWorkflowRun Property Map
manifestGenerationMode String
The mode of generation to be used for generating Manifest.
manifestOutputDirectory String
The directory to output the generated manifests to.
manifestType String
Determines the type of manifests to be generated.
namespace String
Kubernetes namespace the application is deployed to.
oidcCredentials Property Map
The fields needed for OIDC with GitHub.
port String
The port the application is exposed on.
repositoryName String
Repository Name
repositoryOwner String
Repository Owner
tags Map<String>
Resource tags.

Supporting Types

ACRResponse

AcrRegistryName string
ACR registry
AcrRepositoryName string
ACR repository
AcrResourceGroup string
ACR resource group
AcrSubscriptionId string
ACR subscription id
AcrRegistryName string
ACR registry
AcrRepositoryName string
ACR repository
AcrResourceGroup string
ACR resource group
AcrSubscriptionId string
ACR subscription id
acrRegistryName String
ACR registry
acrRepositoryName String
ACR repository
acrResourceGroup String
ACR resource group
acrSubscriptionId String
ACR subscription id
acrRegistryName string
ACR registry
acrRepositoryName string
ACR repository
acrResourceGroup string
ACR resource group
acrSubscriptionId string
ACR subscription id
acr_registry_name str
ACR registry
acr_repository_name str
ACR repository
acr_resource_group str
ACR resource group
acr_subscription_id str
ACR subscription id
acrRegistryName String
ACR registry
acrRepositoryName String
ACR repository
acrResourceGroup String
ACR resource group
acrSubscriptionId String
ACR subscription id

DeploymentPropertiesResponse

HelmChartPath string
Helm chart directory path in repository.
HelmValues string
Helm Values.yaml file location in repository.
KubeManifestLocations List<string>
ManifestType string
Determines the type of manifests within the repository.
Overrides Dictionary<string, string>
Manifest override values.
HelmChartPath string
Helm chart directory path in repository.
HelmValues string
Helm Values.yaml file location in repository.
KubeManifestLocations []string
ManifestType string
Determines the type of manifests within the repository.
Overrides map[string]string
Manifest override values.
helmChartPath String
Helm chart directory path in repository.
helmValues String
Helm Values.yaml file location in repository.
kubeManifestLocations List<String>
manifestType String
Determines the type of manifests within the repository.
overrides Map<String,String>
Manifest override values.
helmChartPath string
Helm chart directory path in repository.
helmValues string
Helm Values.yaml file location in repository.
kubeManifestLocations string[]
manifestType string
Determines the type of manifests within the repository.
overrides {[key: string]: string}
Manifest override values.
helm_chart_path str
Helm chart directory path in repository.
helm_values str
Helm Values.yaml file location in repository.
kube_manifest_locations Sequence[str]
manifest_type str
Determines the type of manifests within the repository.
overrides Mapping[str, str]
Manifest override values.
helmChartPath String
Helm chart directory path in repository.
helmValues String
Helm Values.yaml file location in repository.
kubeManifestLocations List<String>
manifestType String
Determines the type of manifests within the repository.
overrides Map<String>
Manifest override values.

GitHubWorkflowProfileResponseOidcCredentials

AzureClientId string
Azure Application Client ID
AzureTenantId string
Azure Directory (tenant) ID
AzureClientId string
Azure Application Client ID
AzureTenantId string
Azure Directory (tenant) ID
azureClientId String
Azure Application Client ID
azureTenantId String
Azure Directory (tenant) ID
azureClientId string
Azure Application Client ID
azureTenantId string
Azure Directory (tenant) ID
azure_client_id str
Azure Application Client ID
azure_tenant_id str
Azure Directory (tenant) ID
azureClientId String
Azure Application Client ID
azureTenantId String
Azure Directory (tenant) ID

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

WorkflowRunResponse

LastRunAt This property is required. string
The timestamp of the last workflow run.
Succeeded This property is required. bool
Describes if the workflow run succeeded.
WorkflowRunURL This property is required. string
URL to the run of the workflow.
WorkflowRunStatus string
Describes the status of the workflow run
LastRunAt This property is required. string
The timestamp of the last workflow run.
Succeeded This property is required. bool
Describes if the workflow run succeeded.
WorkflowRunURL This property is required. string
URL to the run of the workflow.
WorkflowRunStatus string
Describes the status of the workflow run
lastRunAt This property is required. String
The timestamp of the last workflow run.
succeeded This property is required. Boolean
Describes if the workflow run succeeded.
workflowRunURL This property is required. String
URL to the run of the workflow.
workflowRunStatus String
Describes the status of the workflow run
lastRunAt This property is required. string
The timestamp of the last workflow run.
succeeded This property is required. boolean
Describes if the workflow run succeeded.
workflowRunURL This property is required. string
URL to the run of the workflow.
workflowRunStatus string
Describes the status of the workflow run
last_run_at This property is required. str
The timestamp of the last workflow run.
succeeded This property is required. bool
Describes if the workflow run succeeded.
workflow_run_url This property is required. str
URL to the run of the workflow.
workflow_run_status str
Describes the status of the workflow run
lastRunAt This property is required. String
The timestamp of the last workflow run.
succeeded This property is required. Boolean
Describes if the workflow run succeeded.
workflowRunURL This property is required. String
URL to the run of the workflow.
workflowRunStatus String
Describes the status of the workflow run

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native