steps.getPackage definition

The getPackage step downloads a package from a package management feed in Azure Artifacts or Azure DevOps Server.

steps:
- getPackage: string # Required as first property. ID for the package resource. 
  path: string # Path to download the package into. 
  condition: string # Evaluate this condition expression to determine whether to run this task. 
  continueOnError: boolean # Continue running even on failure?.  (false,n,no,off,on,true,y,yes)
  displayName: string # Human-readable name for the task. 
  target: stepTarget # Environment in which to run this task
  enabled: boolean # Run this task when the job runs?.  (false,n,no,off,on,true,y,yes)
  env:  # Variables to map into the process's environment
    string: string # Name/value pairs.
  name: string # ID of the step.  ([-_A-Za-z0-9]*)
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it. 

Properties that use this definition: steps

Properties

getPackage

string

Required as first parameter. ID for the package resource.

path

string

Path to download the package into.

condition

string

Evaluate this condition expression to determine whether to run this task.

continueOnError

boolean

Continue running even on failure?

displayName

string

Human-readable name for the task.

target

target

Environment in which to run this task.

enabled

boolean

Run this task when the job runs?

env

string name/value pairs

Variables to map into the process's environment.

name

string

ID of the step. Acceptable values: [_A-Za-z0-9]*

timeoutInMinutes

string

Time to wait for this task to complete before the server kills it.

steps:
- getPackage: string # Required as first property. ID for the package resource. 
  path: string # Path to download the package into. 
  condition: string # Evaluate this condition expression to determine whether to run this task. 
  continueOnError: boolean # Continue running even on failure?.  (false,n,no,off,on,true,y,yes)
  displayName: string # Human-readable name for the task. 
  target: stepTarget # Environment in which to run this task
  enabled: boolean # Run this task when the job runs?.  (false,n,no,off,on,true,y,yes)
  env:  # Variables to map into the process's environment
    string: string # Name/value pairs.
  name: string # ID of the step.  ([-_A-Za-z0-9]*)
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it. 

Properties that use this definition: steps

Properties

getPackage

string

Required as first parameter. ID for the package resource.

path

string

Path to download the package into.

condition

string

Evaluate this condition expression to determine whether to run this task.

continueOnError

boolean

Continue running even on failure?

displayName

string

Human-readable name for the task.

target

target

Environment in which to run this task.

enabled

boolean

Run this task when the job runs?

env

string name/value pairs

Variables to map into the process's environment.

name

string

ID of the step. Acceptable values: [_A-Za-z0-9]*

timeoutInMinutes

string

Time to wait for this task to complete before the server kills it.

steps:
- getPackage: string # Required as first property. ID for the package resource. 
  path: string # Path to download the package into. 
  condition: string # Evaluate this condition expression to determine whether to run this task. 
  continueOnError: boolean # Continue running even on failure?.  (false,n,no,off,on,true,y,yes)
  displayName: string # Human-readable name for the task. 
  target: stepTarget # Environment in which to run this task
  enabled: boolean # Run this task when the job runs?.  (false,n,no,off,on,true,y,yes)
  env:  # Variables to map into the process's environment
    string: string # Name/value pairs.
  name: string # ID of the step.  ([-_A-Za-z0-9]*)
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it. 
  retryCountOnTaskFailure: string # Number of retries if the task fails. 

Properties that use this definition: steps

Properties

getPackage

string

Required as first parameter. ID for the package resource.

path

string

Path to download the package into.

condition

string

Evaluate this condition expression to determine whether to run this task.

continueOnError

boolean

Continue running even on failure?

displayName

string

Human-readable name for the task.

target

target

Environment in which to run this task.

enabled

boolean

Run this task when the job runs?

env

string name/value pairs

Variables to map into the process's environment.

name

string

ID of the step. Acceptable values: [-_A-Za-z0-9]*

timeoutInMinutes

string

Time to wait for this task to complete before the server kills it.

retryCountOnTaskFailure

string

Number of retries if the task fails.

steps:
- getPackage: string # Required as first property. ID for the package resource. 
  path: string # Path to download the package into. 
  condition: string # Evaluate this condition expression to determine whether to run this task. 
  continueOnError: boolean # Continue running even on failure?.  (false,n,no,off,on,true,y,yes)
  displayName: string # Human-readable name for the task. 
  target: stepTarget # Environment in which to run this task
  enabled: boolean # Run this task when the job runs?.  (false,n,no,off,on,true,y,yes)
  env:  # Variables to map into the process's environment
    string: string # Name/value pairs.
  name: string # ID of the step.  ([-_A-Za-z0-9]*)
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it. 
  retryCountOnTaskFailure: string # Number of retries if the task fails. 

Properties that use this definition: steps

Properties

getPackage

string

Required as first parameter. ID for the package resource.

path

string

Path to download the package into.

condition

string

Evaluate this condition expression to determine whether to run this task.

continueOnError

boolean

Continue running even on failure?

displayName

string

Human-readable name for the task.

target

target

Environment in which to run this task.

enabled

boolean

Run this task when the job runs?

env

string name/value pairs

Variables to map into the process's environment.

name

string

ID of the step. Acceptable values: [-_A-Za-z0-9]*

timeoutInMinutes

string

Time to wait for this task to complete before the server kills it.

retryCountOnTaskFailure

string

Number of retries if the task fails.

Remarks

The getPackage keyword is a shortcut for the Download Package task.

See also