Workflow interface

  • Reference
Package:
@azure/arm-devhub

Resource representation of a workflow

Extends
TrackedResource

Properties

acr

Information on the azure container registry
aksResourceId

The Azure Kubernetes Cluster Resource the application will be deployed to.
appName

The name of the app.
authStatus

Determines the authorization status of requests. NOTE: This property will not be serialized. It can only be populated by the server.
branchName

Repository Branch Name
builderVersion

The version of the language image used for building the code in the generated dockerfile.
deploymentProperties
dockerBuildContext

Path to Dockerfile Build Context within the repository.
dockerfile

Path to the Dockerfile within the repository.
dockerfileGenerationMode

The mode of generation to be used for generating Dockerfiles.
dockerfileOutputDirectory

The directory to output the generated Dockerfile to.
generationLanguage

The programming language used.
imageName

The name of the image to be generated.
imageTag

The tag to apply to the generated image.
languageVersion

The version of the language image used for execution in the generated dockerfile.
lastWorkflowRun
manifestGenerationMode

The mode of generation to be used for generating Manifest.
manifestOutputDirectory

The directory to output the generated manifests to.
manifestType

Determines the type of manifests to be generated.
namespacePropertiesArtifactGenerationPropertiesNamespace

The namespace to deploy the application to.
namespacePropertiesGithubWorkflowProfileNamespace

Kubernetes namespace the application is deployed to.
oidcCredentials

The fields needed for OIDC with GitHub.
port

The port the application is exposed on.
prStatus

The status of the Pull Request submitted against the users repository. NOTE: This property will not be serialized. It can only be populated by the server.
prURL

The URL to the Pull Request submitted against the users repository. NOTE: This property will not be serialized. It can only be populated by the server.
pullNumber

The number associated with the submitted pull request. NOTE: This property will not be serialized. It can only be populated by the server.
repositoryName

Repository Name
repositoryOwner

Repository Owner

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

acr

Information on the azure container registry

acr?: Acr

Property Value

Acr

aksResourceId

The Azure Kubernetes Cluster Resource the application will be deployed to.

aksResourceId?: string

Property Value

string

appName

The name of the app.

appName?: string

Property Value

string

authStatus

Determines the authorization status of requests. NOTE: This property will not be serialized. It can only be populated by the server.

authStatus?: string

Property Value

string

branchName

Repository Branch Name

branchName?: string

Property Value

string

builderVersion

The version of the language image used for building the code in the generated dockerfile.

builderVersion?: string

Property Value

string

deploymentProperties 

deploymentProperties?: DeploymentProperties

Property Value

DeploymentProperties

dockerBuildContext

Path to Dockerfile Build Context within the repository.

dockerBuildContext?: string

Property Value

string

dockerfile

Path to the Dockerfile within the repository.

dockerfile?: string

Property Value

string

dockerfileGenerationMode

The mode of generation to be used for generating Dockerfiles.

dockerfileGenerationMode?: string

Property Value

string

dockerfileOutputDirectory

The directory to output the generated Dockerfile to.

dockerfileOutputDirectory?: string

Property Value

string

generationLanguage

The programming language used.

generationLanguage?: string

Property Value

string

imageName

The name of the image to be generated.

imageName?: string

Property Value

string

imageTag

The tag to apply to the generated image.

imageTag?: string

Property Value

string

languageVersion

The version of the language image used for execution in the generated dockerfile.

languageVersion?: string

Property Value

string

lastWorkflowRun 

lastWorkflowRun?: WorkflowRun

Property Value

WorkflowRun

manifestGenerationMode

The mode of generation to be used for generating Manifest.

manifestGenerationMode?: string

Property Value

string

manifestOutputDirectory

The directory to output the generated manifests to.

manifestOutputDirectory?: string

Property Value

string

manifestType

Determines the type of manifests to be generated.

manifestType?: string

Property Value

string

namespacePropertiesArtifactGenerationPropertiesNamespace

The namespace to deploy the application to.

namespacePropertiesArtifactGenerationPropertiesNamespace?: string

Property Value

string

namespacePropertiesGithubWorkflowProfileNamespace

Kubernetes namespace the application is deployed to.

namespacePropertiesGithubWorkflowProfileNamespace?: string

Property Value

string

oidcCredentials

The fields needed for OIDC with GitHub.

oidcCredentials?: GitHubWorkflowProfileOidcCredentials

Property Value

GitHubWorkflowProfileOidcCredentials

port

The port the application is exposed on.

port?: string

Property Value

string

prStatus

The status of the Pull Request submitted against the users repository. NOTE: This property will not be serialized. It can only be populated by the server.

prStatus?: string

Property Value

string

prURL

The URL to the Pull Request submitted against the users repository. NOTE: This property will not be serialized. It can only be populated by the server.

prURL?: string

Property Value

string

pullNumber

The number associated with the submitted pull request. NOTE: This property will not be serialized. It can only be populated by the server.

pullNumber?: number

Property Value

number

repositoryName

Repository Name

repositoryName?: string

Property Value

string

repositoryOwner

Repository Owner

repositoryOwner?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type