azure-native.devhub.getWorkflow
Explore with Pulumi AI
Resource representation of a workflow
Uses Azure REST API version 2023-08-01.
Other available API versions: 2022-10-11-preview, 2024-05-01-preview, 2024-08-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native devhub [ApiVersion]
. See the version guide for details.
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>
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]
func LookupWorkflow(ctx *Context, args *LookupWorkflowArgs, opts ...InvokeOption) (*LookupWorkflowResult, error)
func LookupWorkflowOutput(ctx *Context, args *LookupWorkflowOutputArgs, opts ...InvokeOption) LookupWorkflowResultOutput
> 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)
}
public static CompletableFuture<GetWorkflowResult> getWorkflow(GetWorkflowArgs args, InvokeOptions options)
public static Output<GetWorkflowResult> getWorkflow(GetWorkflowArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:devhub:getWorkflow
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Workflow
Name string - The name of the workflow resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Workflow
Name string - The name of the workflow resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- workflow
Name String - The name of the workflow resource.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- workflow
Name string - The name of the workflow resource.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- workflow_
name str - The name of the workflow resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- workflow
Name String - The name of the workflow resource.
getWorkflow Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
- System
Data Pulumi.Azure Native. Dev Hub. Outputs. System Data Response - 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"
- App
Name string - The name of the app.
- Builder
Version string - The version of the language image used for building the code in the generated dockerfile.
- Dockerfile
Generation stringMode - The mode of generation to be used for generating Dockerfiles.
- Dockerfile
Output stringDirectory - The directory to output the generated Dockerfile to.
- Generation
Language string - The programming language used.
- Github
Workflow Pulumi.Profile Azure Native. Dev Hub. Outputs. Git Hub Workflow Profile Response - Profile of a github workflow.
- Image
Name string - The name of the image to be generated.
- Image
Tag string - The tag to apply to the generated image.
- Language
Version string - The version of the language image used for execution in the generated dockerfile.
- Manifest
Generation stringMode - The mode of generation to be used for generating Manifest.
- Manifest
Output stringDirectory - The directory to output the generated manifests to.
- Manifest
Type string - Determines the type of manifests to be generated.
- Namespace string
- The namespace to deploy the application to.
- Port string
- The port the application is exposed on.
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
- System
Data SystemData Response - 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"
- App
Name string - The name of the app.
- Builder
Version string - The version of the language image used for building the code in the generated dockerfile.
- Dockerfile
Generation stringMode - The mode of generation to be used for generating Dockerfiles.
- Dockerfile
Output stringDirectory - The directory to output the generated Dockerfile to.
- Generation
Language string - The programming language used.
- Github
Workflow GitProfile Hub Workflow Profile Response - Profile of a github workflow.
- Image
Name string - The name of the image to be generated.
- Image
Tag string - The tag to apply to the generated image.
- Language
Version string - The version of the language image used for execution in the generated dockerfile.
- Manifest
Generation stringMode - The mode of generation to be used for generating Manifest.
- Manifest
Output stringDirectory - The directory to output the generated manifests to.
- Manifest
Type string - Determines the type of manifests to be generated.
- Namespace string
- The namespace to deploy the application to.
- Port string
- The port the application is exposed on.
- map[string]string
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- 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
- system
Data SystemData Response - 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"
- app
Name String - The name of the app.
- builder
Version String - The version of the language image used for building the code in the generated dockerfile.
- dockerfile
Generation StringMode - The mode of generation to be used for generating Dockerfiles.
- dockerfile
Output StringDirectory - The directory to output the generated Dockerfile to.
- generation
Language String - The programming language used.
- github
Workflow GitProfile Hub Workflow Profile Response - Profile of a github workflow.
- image
Name String - The name of the image to be generated.
- image
Tag String - The tag to apply to the generated image.
- language
Version String - The version of the language image used for execution in the generated dockerfile.
- manifest
Generation StringMode - The mode of generation to be used for generating Manifest.
- manifest
Output StringDirectory - The directory to output the generated manifests to.
- manifest
Type String - Determines the type of manifests to be generated.
- namespace String
- The namespace to deploy the application to.
- port String
- The port the application is exposed on.
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - The Azure API version of the resource.
- 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
- system
Data SystemData Response - 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"
- app
Name string - The name of the app.
- builder
Version string - The version of the language image used for building the code in the generated dockerfile.
- dockerfile
Generation stringMode - The mode of generation to be used for generating Dockerfiles.
- dockerfile
Output stringDirectory - The directory to output the generated Dockerfile to.
- generation
Language string - The programming language used.
- github
Workflow GitProfile Hub Workflow Profile Response - Profile of a github workflow.
- image
Name string - The name of the image to be generated.
- image
Tag string - The tag to apply to the generated image.
- language
Version string - The version of the language image used for execution in the generated dockerfile.
- manifest
Generation stringMode - The mode of generation to be used for generating Manifest.
- manifest
Output stringDirectory - The directory to output the generated manifests to.
- manifest
Type string - Determines the type of manifests to be generated.
- namespace string
- The namespace to deploy the application to.
- port string
- The port the application is exposed on.
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - The Azure API version of the resource.
- 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
- system_
data SystemData Response - 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"
- app_
name str - The name of the app.
- builder_
version str - The version of the language image used for building the code in the generated dockerfile.
- dockerfile_
generation_ strmode - The mode of generation to be used for generating Dockerfiles.
- dockerfile_
output_ strdirectory - The directory to output the generated Dockerfile to.
- generation_
language str - The programming language used.
- github_
workflow_ Gitprofile Hub Workflow Profile Response - Profile of a github workflow.
- 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.
- manifest_
generation_ strmode - The mode of generation to be used for generating Manifest.
- manifest_
output_ strdirectory - The directory to output the generated manifests to.
- manifest_
type str - Determines the type of manifests to be generated.
- namespace str
- The namespace to deploy the application to.
- port str
- The port the application is exposed on.
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- 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
- system
Data 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"
- app
Name String - The name of the app.
- builder
Version String - The version of the language image used for building the code in the generated dockerfile.
- dockerfile
Generation StringMode - The mode of generation to be used for generating Dockerfiles.
- dockerfile
Output StringDirectory - The directory to output the generated Dockerfile to.
- generation
Language String - The programming language used.
- github
Workflow Property MapProfile - Profile of a github workflow.
- image
Name String - The name of the image to be generated.
- image
Tag String - The tag to apply to the generated image.
- language
Version String - The version of the language image used for execution in the generated dockerfile.
- manifest
Generation StringMode - The mode of generation to be used for generating Manifest.
- manifest
Output StringDirectory - The directory to output the generated manifests to.
- manifest
Type String - Determines the type of manifests to be generated.
- namespace String
- The namespace to deploy the application to.
- port String
- The port the application is exposed on.
- Map<String>
- Resource tags.
Supporting Types
ACRResponse
- Acr
Registry stringName - ACR registry
- Acr
Repository stringName - ACR repository
- Acr
Resource stringGroup - ACR resource group
- Acr
Subscription stringId - ACR subscription id
- Acr
Registry stringName - ACR registry
- Acr
Repository stringName - ACR repository
- Acr
Resource stringGroup - ACR resource group
- Acr
Subscription stringId - ACR subscription id
- acr
Registry StringName - ACR registry
- acr
Repository StringName - ACR repository
- acr
Resource StringGroup - ACR resource group
- acr
Subscription StringId - ACR subscription id
- acr
Registry stringName - ACR registry
- acr
Repository stringName - ACR repository
- acr
Resource stringGroup - ACR resource group
- acr
Subscription stringId - ACR subscription id
- acr_
registry_ strname - ACR registry
- acr_
repository_ strname - ACR repository
- acr_
resource_ strgroup - ACR resource group
- acr_
subscription_ strid - ACR subscription id
- acr
Registry StringName - ACR registry
- acr
Repository StringName - ACR repository
- acr
Resource StringGroup - ACR resource group
- acr
Subscription StringId - ACR subscription id
DeploymentPropertiesResponse
- Helm
Chart stringPath - Helm chart directory path in repository.
- Helm
Values string - Helm Values.yaml file location in repository.
- Kube
Manifest List<string>Locations - Manifest
Type string - Determines the type of manifests within the repository.
- Overrides Dictionary<string, string>
- Manifest override values.
- Helm
Chart stringPath - Helm chart directory path in repository.
- Helm
Values string - Helm Values.yaml file location in repository.
- Kube
Manifest []stringLocations - Manifest
Type string - Determines the type of manifests within the repository.
- Overrides map[string]string
- Manifest override values.
- helm
Chart StringPath - Helm chart directory path in repository.
- helm
Values String - Helm Values.yaml file location in repository.
- kube
Manifest List<String>Locations - manifest
Type String - Determines the type of manifests within the repository.
- overrides Map<String,String>
- Manifest override values.
- helm
Chart stringPath - Helm chart directory path in repository.
- helm
Values string - Helm Values.yaml file location in repository.
- kube
Manifest string[]Locations - manifest
Type string - Determines the type of manifests within the repository.
- overrides {[key: string]: string}
- Manifest override values.
- helm_
chart_ strpath - Helm chart directory path in repository.
- helm_
values str - Helm Values.yaml file location in repository.
- kube_
manifest_ Sequence[str]locations - manifest_
type str - Determines the type of manifests within the repository.
- overrides Mapping[str, str]
- Manifest override values.
- helm
Chart StringPath - Helm chart directory path in repository.
- helm
Values String - Helm Values.yaml file location in repository.
- kube
Manifest List<String>Locations - manifest
Type String - Determines the type of manifests within the repository.
- overrides Map<String>
- Manifest override values.
GitHubWorkflowProfileResponse
- Auth
Status string - Determines the authorization status of requests.
- Pr
Status string - The status of the Pull Request submitted against the users repository.
- Pr
URL string - The URL to the Pull Request submitted against the users repository.
- Pull
Number int - The number associated with the submitted pull request.
- Acr
Pulumi.
Azure Native. Dev Hub. Inputs. ACRResponse - Information on the azure container registry
- Aks
Resource stringId - The Azure Kubernetes Cluster Resource the application will be deployed to.
- Branch
Name string - Repository Branch Name
- Deployment
Properties Pulumi.Azure Native. Dev Hub. Inputs. Deployment Properties Response - Docker
Build stringContext - Path to Dockerfile Build Context within the repository.
- Dockerfile string
- Path to the Dockerfile within the repository.
- Last
Workflow Pulumi.Run Azure Native. Dev Hub. Inputs. Workflow Run Response - Namespace string
- Kubernetes namespace the application is deployed to.
- Oidc
Credentials Pulumi.Azure Native. Dev Hub. Inputs. Git Hub Workflow Profile Response Oidc Credentials - The fields needed for OIDC with GitHub.
- Repository
Name string - Repository Name
- Repository
Owner string - Repository Owner
- Auth
Status string - Determines the authorization status of requests.
- Pr
Status string - The status of the Pull Request submitted against the users repository.
- Pr
URL string - The URL to the Pull Request submitted against the users repository.
- Pull
Number int - The number associated with the submitted pull request.
- Acr ACRResponse
- Information on the azure container registry
- Aks
Resource stringId - The Azure Kubernetes Cluster Resource the application will be deployed to.
- Branch
Name string - Repository Branch Name
- Deployment
Properties DeploymentProperties Response - Docker
Build stringContext - Path to Dockerfile Build Context within the repository.
- Dockerfile string
- Path to the Dockerfile within the repository.
- Last
Workflow WorkflowRun Run Response - Namespace string
- Kubernetes namespace the application is deployed to.
- Oidc
Credentials GitHub Workflow Profile Response Oidc Credentials - The fields needed for OIDC with GitHub.
- Repository
Name string - Repository Name
- Repository
Owner string - Repository Owner
- auth
Status String - Determines the authorization status of requests.
- pr
Status String - The status of the Pull Request submitted against the users repository.
- pr
URL String - The URL to the Pull Request submitted against the users repository.
- pull
Number Integer - The number associated with the submitted pull request.
- acr ACRResponse
- Information on the azure container registry
- aks
Resource StringId - The Azure Kubernetes Cluster Resource the application will be deployed to.
- branch
Name String - Repository Branch Name
- deployment
Properties DeploymentProperties Response - docker
Build StringContext - Path to Dockerfile Build Context within the repository.
- dockerfile String
- Path to the Dockerfile within the repository.
- last
Workflow WorkflowRun Run Response - namespace String
- Kubernetes namespace the application is deployed to.
- oidc
Credentials GitHub Workflow Profile Response Oidc Credentials - The fields needed for OIDC with GitHub.
- repository
Name String - Repository Name
- repository
Owner String - Repository Owner
- auth
Status string - Determines the authorization status of requests.
- pr
Status string - The status of the Pull Request submitted against the users repository.
- pr
URL string - The URL to the Pull Request submitted against the users repository.
- pull
Number number - The number associated with the submitted pull request.
- acr ACRResponse
- Information on the azure container registry
- aks
Resource stringId - The Azure Kubernetes Cluster Resource the application will be deployed to.
- branch
Name string - Repository Branch Name
- deployment
Properties DeploymentProperties Response - docker
Build stringContext - Path to Dockerfile Build Context within the repository.
- dockerfile string
- Path to the Dockerfile within the repository.
- last
Workflow WorkflowRun Run Response - namespace string
- Kubernetes namespace the application is deployed to.
- oidc
Credentials GitHub Workflow Profile Response Oidc Credentials - The fields needed for OIDC with GitHub.
- repository
Name string - Repository Name
- repository
Owner string - Repository Owner
- auth_
status str - Determines the authorization status of requests.
- 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.
- acr ACRResponse
- Information on the azure container registry
- aks_
resource_ strid - The Azure Kubernetes Cluster Resource the application will be deployed to.
- branch_
name str - Repository Branch Name
- deployment_
properties DeploymentProperties Response - docker_
build_ strcontext - Path to Dockerfile Build Context within the repository.
- dockerfile str
- Path to the Dockerfile within the repository.
- last_
workflow_ Workflowrun Run Response - namespace str
- Kubernetes namespace the application is deployed to.
- oidc_
credentials GitHub Workflow Profile Response Oidc Credentials - The fields needed for OIDC with GitHub.
- repository_
name str - Repository Name
- repository_
owner str - Repository Owner
- auth
Status String - Determines the authorization status of requests.
- pr
Status String - The status of the Pull Request submitted against the users repository.
- pr
URL String - The URL to the Pull Request submitted against the users repository.
- pull
Number Number - The number associated with the submitted pull request.
- acr Property Map
- Information on the azure container registry
- aks
Resource StringId - The Azure Kubernetes Cluster Resource the application will be deployed to.
- branch
Name String - Repository Branch Name
- deployment
Properties Property Map - docker
Build StringContext - Path to Dockerfile Build Context within the repository.
- dockerfile String
- Path to the Dockerfile within the repository.
- last
Workflow Property MapRun - namespace String
- Kubernetes namespace the application is deployed to.
- oidc
Credentials Property Map - The fields needed for OIDC with GitHub.
- repository
Name String - Repository Name
- repository
Owner String - Repository Owner
GitHubWorkflowProfileResponseOidcCredentials
- Azure
Client stringId - Azure Application Client ID
- Azure
Tenant stringId - Azure Directory (tenant) ID
- Azure
Client stringId - Azure Application Client ID
- Azure
Tenant stringId - Azure Directory (tenant) ID
- azure
Client StringId - Azure Application Client ID
- azure
Tenant StringId - Azure Directory (tenant) ID
- azure
Client stringId - Azure Application Client ID
- azure
Tenant stringId - Azure Directory (tenant) ID
- azure_
client_ strid - Azure Application Client ID
- azure_
tenant_ strid - Azure Directory (tenant) ID
- azure
Client StringId - Azure Application Client ID
- azure
Tenant StringId - Azure Directory (tenant) ID
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
WorkflowRunResponse
- Last
Run stringAt - The timestamp of the last workflow run.
- Succeeded bool
- Describes if the workflow run succeeded.
- Workflow
Run stringURL - URL to the run of the workflow.
- Workflow
Run stringStatus - Describes the status of the workflow run
- Last
Run stringAt - The timestamp of the last workflow run.
- Succeeded bool
- Describes if the workflow run succeeded.
- Workflow
Run stringURL - URL to the run of the workflow.
- Workflow
Run stringStatus - Describes the status of the workflow run
- last
Run StringAt - The timestamp of the last workflow run.
- succeeded Boolean
- Describes if the workflow run succeeded.
- workflow
Run StringURL - URL to the run of the workflow.
- workflow
Run StringStatus - Describes the status of the workflow run
- last
Run stringAt - The timestamp of the last workflow run.
- succeeded boolean
- Describes if the workflow run succeeded.
- workflow
Run stringURL - URL to the run of the workflow.
- workflow
Run stringStatus - Describes the status of the workflow run
- last_
run_ strat - The timestamp of the last workflow run.
- succeeded bool
- Describes if the workflow run succeeded.
- workflow_
run_ strurl - URL to the run of the workflow.
- workflow_
run_ strstatus - Describes the status of the workflow run
- last
Run StringAt - The timestamp of the last workflow run.
- succeeded Boolean
- Describes if the workflow run succeeded.
- workflow
Run StringURL - URL to the run of the workflow.
- workflow
Run StringStatus - Describes the status of the workflow run
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0