workflow

Creates, updates, deletes, gets or lists a workflow resource.

Overview

Name	workflow
Type	Resource
Id	azure_extras.devhub.workflow

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
artifactGenerationProperties	object	Properties for generating artifacts like dockerfile and manifests.
azurePipelineProfile	object	Profile of an azure pipeline.
githubWorkflowProfile	object	Profile of a github workflow.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateWorkflowProfile	object	Profile of an template workflow.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
artifactGenerationProperties	object	Properties for generating artifacts like dockerfile and manifests.
azurePipelineProfile	object	Profile of an azure pipeline.
githubWorkflowProfile	object	Profile of a github workflow.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateWorkflowProfile	object	Profile of an template workflow.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
artifactGenerationProperties	object	Properties for generating artifacts like dockerfile and manifests.
azurePipelineProfile	object	Profile of an azure pipeline.
githubWorkflowProfile	object	Profile of a github workflow.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateWorkflowProfile	object	Profile of an template workflow.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workflow_name, subscription_id		Gets a workflow. Gets a workflow.
list_by_resource_group	select	resource_group_name, subscription_id	managedClusterResource	Gets a list of workflows within a resource group. Gets a list of workflows within a resource group.
list	select	subscription_id		Gets a list of workflows associated with the specified subscription. Gets a list of workflows associated with the specified subscription.
create_or_update	insert	resource_group_name, workflow_name, subscription_id, location		Creates or updates a workflow. Creates or updates a workflow.
update_tags	update	resource_group_name, workflow_name, subscription_id		Updates tags on a workflow. Updates tags on a workflow.
create_or_update	replace	resource_group_name, workflow_name, subscription_id, location		Creates or updates a workflow. Creates or updates a workflow.
delete	delete	resource_group_name, workflow_name, subscription_id		Deletes a workflow. Deletes a workflow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workflow_name	string	The name of the workflow resource. Required.
managedClusterResource	string	The ManagedCluster resource associated with the workflows. Default value is None.

SELECT examples

get

Gets a workflow. Gets a workflow.

SELECT
id,
name,
artifactGenerationProperties,
azurePipelineProfile,
githubWorkflowProfile,
location,
systemData,
tags,
templateWorkflowProfile,
type
FROM azure_extras.devhub.workflow
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of workflows within a resource group. Gets a list of workflows within a resource group.

SELECT
id,
name,
artifactGenerationProperties,
azurePipelineProfile,
githubWorkflowProfile,
location,
systemData,
tags,
templateWorkflowProfile,
type
FROM azure_extras.devhub.workflow
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND managedClusterResource = '{{ managedClusterResource }}'
;

list

Gets a list of workflows associated with the specified subscription. Gets a list of workflows associated with the specified subscription.

SELECT
id,
name,
artifactGenerationProperties,
azurePipelineProfile,
githubWorkflowProfile,
location,
systemData,
tags,
templateWorkflowProfile,
type
FROM azure_extras.devhub.workflow
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workflow. Creates or updates a workflow.

INSERT INTO azure_extras.devhub.workflow (
tags,
location,
properties,
resource_group_name,
workflow_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workflow_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workflow
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workflow resource.
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the workflow resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workflow resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of a workflow.
    value:
      githubWorkflowProfile:
        repositoryOwner: "{{ repositoryOwner }}"
        repositoryName: "{{ repositoryName }}"
        branchName: "{{ branchName }}"
        dockerfile: "{{ dockerfile }}"
        dockerBuildContext: "{{ dockerBuildContext }}"
        deploymentProperties:
          manifestType: "{{ manifestType }}"
          kubeManifestLocations:
            - "{{ kubeManifestLocations }}"
          helmChartPath: "{{ helmChartPath }}"
          helmValues: "{{ helmValues }}"
          overrides: "{{ overrides }}"
        namespace: "{{ namespace }}"
        acr:
          acrSubscriptionId: "{{ acrSubscriptionId }}"
          acrResourceGroup: "{{ acrResourceGroup }}"
          acrRegistryName: "{{ acrRegistryName }}"
          acrRepositoryName: "{{ acrRepositoryName }}"
        oidcCredentials:
          azureClientId: "{{ azureClientId }}"
          azureTenantId: "{{ azureTenantId }}"
        aksResourceId: "{{ aksResourceId }}"
        prURL: "{{ prURL }}"
        pullNumber: {{ pullNumber }}
        prStatus: "{{ prStatus }}"
        lastWorkflowRun:
          succeeded: {{ succeeded }}
          workflowRunURL: "{{ workflowRunURL }}"
          lastRunAt: "{{ lastRunAt }}"
          workflowRunStatus: "{{ workflowRunStatus }}"
        authStatus: "{{ authStatus }}"
      artifactGenerationProperties:
        generationLanguage: "{{ generationLanguage }}"
        languageVersion: "{{ languageVersion }}"
        builderVersion: "{{ builderVersion }}"
        port: "{{ port }}"
        appName: "{{ appName }}"
        dockerfileOutputDirectory: "{{ dockerfileOutputDirectory }}"
        manifestOutputDirectory: "{{ manifestOutputDirectory }}"
        dockerfileGenerationMode: "{{ dockerfileGenerationMode }}"
        manifestGenerationMode: "{{ manifestGenerationMode }}"
        manifestType: "{{ manifestType }}"
        imageName: "{{ imageName }}"
        namespace: "{{ namespace }}"
        imageTag: "{{ imageTag }}"
      azurePipelineProfile:
        repository:
          repositoryOwner: "{{ repositoryOwner }}"
          repositoryName: "{{ repositoryName }}"
          branchName: "{{ branchName }}"
          adoOrganization: "{{ adoOrganization }}"
          projectName: "{{ projectName }}"
        armServiceConnection: "{{ armServiceConnection }}"
        build:
          dockerfile: "{{ dockerfile }}"
          dockerBuildContext: "{{ dockerBuildContext }}"
        deployment:
          manifestType: "{{ manifestType }}"
          kubeManifestLocations:
            - "{{ kubeManifestLocations }}"
          helmChartPath: "{{ helmChartPath }}"
          helmValues: "{{ helmValues }}"
          overrides: "{{ overrides }}"
        namespace: "{{ namespace }}"
        acr: "{{ acr }}"
        clusterId: "{{ clusterId }}"
        pullRequest:
          prURL: "{{ prURL }}"
          pullNumber: {{ pullNumber }}
          prStatus: "{{ prStatus }}"
        lastWorkflowRun:
          succeeded: {{ succeeded }}
          workflowRunURL: "{{ workflowRunURL }}"
          lastRunAt: "{{ lastRunAt }}"
          workflowRunStatus: "{{ workflowRunStatus }}"
        authStatus: "{{ authStatus }}"
      templateWorkflowProfile:
        repositoryProvider: "{{ repositoryProvider }}"
        workflowTemplate:
          templateId: "{{ templateId }}"
          destination: "{{ destination }}"
          parameters: "{{ parameters }}"
        deploymentTemplate:
          templateId: "{{ templateId }}"
          destination: "{{ destination }}"
          parameters: "{{ parameters }}"
        dockerfileTemplate:
          templateId: "{{ templateId }}"
          destination: "{{ destination }}"
          parameters: "{{ parameters }}"
        manifestTemplates:
          - templateId: "{{ templateId }}"
            destination: "{{ destination }}"
            parameters: "{{ parameters }}"
        gitHubProviderProfile:
          repository:
            repositoryOwner: "{{ repositoryOwner }}"
            repositoryName: "{{ repositoryName }}"
            branchName: "{{ branchName }}"
          oidcCredentials:
            azureClientId: "{{ azureClientId }}"
            azureTenantId: "{{ azureTenantId }}"
        adoProviderProfile:
          repository:
            repositoryOwner: "{{ repositoryOwner }}"
            repositoryName: "{{ repositoryName }}"
            branchName: "{{ branchName }}"
            adoOrganization: "{{ adoOrganization }}"
            projectName: "{{ projectName }}"
          armServiceConnection: "{{ armServiceConnection }}"
        pullRequest:
          prURL: "{{ prURL }}"
          pullNumber: {{ pullNumber }}
          prStatus: "{{ prStatus }}"
        lastWorkflowRun:
          succeeded: {{ succeeded }}
          workflowRunURL: "{{ workflowRunURL }}"
          lastRunAt: "{{ lastRunAt }}"
          workflowRunStatus: "{{ workflowRunStatus }}"
        authStatus: "{{ authStatus }}"

UPDATE examples

update_tags

Updates tags on a workflow. Updates tags on a workflow.

UPDATE azure_extras.devhub.workflow
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a workflow. Creates or updates a workflow.

REPLACE azure_extras.devhub.workflow
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a workflow. Deletes a workflow.

DELETE FROM azure_extras.devhub.workflow
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workflow_name = '{{ workflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;