Share via

az acr pipeline-run

  • Preview
  • Reference

Note

This reference is part of the acrtransfer extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az acr pipeline-run command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage ACR import and export pipeline-runs.

Commands

Name Description Type Status
az acr pipeline-run clean

Delete all failed pipeline-runs on the registry.

 Extension Preview
az acr pipeline-run create

Create a pipeline-run.

 Extension Preview
az acr pipeline-run delete

Delete a pipeline-run.

 Extension Preview
az acr pipeline-run list

List pipeline-runs of all pipelines on a container registry.

 Extension Preview
az acr pipeline-run show

Show a pipeline-run in detail.

 Extension Preview

az acr pipeline-run clean

Preview

Command group 'acr pipeline-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete all failed pipeline-runs on the registry.

az acr pipeline-run clean --registry
                          --resource-group
                          [--dry-run]

Examples

Delete all failed pipeline-runs on the registry.

az acr pipeline-run clean --resource-group $MyRG --registry $MyReg

List the failed pipeline-runs that would have been deleted, but do not delete any.

az acr pipeline-run clean --resource-group $MyRG --registry $MyReg --dry-run -o table

Required Parameters

--registry -r

Name of registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--dry-run

List the failed pipeline-runs that would have been deleted, but do not delete any.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acr pipeline-run create

Preview

Command group 'acr pipeline-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a pipeline-run.

az acr pipeline-run create --name
                           --pipeline
                           --pipeline-type
                           --registry
                           --resource-group
                           --storage-blob
                           [--artifacts]
                           [--force-redeploy]

Examples

Create an import pipeline-run.

az acr pipeline-run create --resource-group $MyRG --registry $MyReg --pipeline $MyPipeline --name $MyPipelineRunName --pipeline-type import --storage-blob $MyBlob

Create an export pipeline-run and force redeploy.

az acr pipeline-run create --resource-group $MyRG --registry $MyReg --pipeline $MyPipeline --name $MyPipelineRunName --pipeline-type export --storage-blob $MyBlob --artifacts hello-world:latest hello-world@sha256:90659bf80b44ce6be8234e6ff90a1ac34acbeb826903b02cfa0da11c82cbc042 --force-redeploy

Required Parameters

--name -n

Name of the pipeline run.

--pipeline -p

Name of the pipeline to run.

--pipeline-type -t

Type of pipeline. Must be either import or export.

--registry -r

Name of registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--storage-blob -b

Name of the storage blob to be imported or exported.

Optional Parameters

--artifacts -a

Space-separated list of container artifacts. Artifacts must be either of the form repository:tag or repository@digest such as hello-world:latest or hello-world@sha256:90659bf80b44ce6be8234e6ff90a1ac34acbeb826903b02cfa0da11c82cbc042.

--force-redeploy -f

Flag that forces ARM to redeploy resource even if no parameters have changed.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acr pipeline-run delete

Preview

Command group 'acr pipeline-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a pipeline-run.

az acr pipeline-run delete --name
                           --registry
                           --resource-group

Examples

Delete a pipeline-run.

az acr pipeline-run delete --resource-group $MyRG --registry $MyReg --name $MyPipelineRun

Required Parameters

--name -n

Name of the pipeline run.

--registry -r

Name of registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acr pipeline-run list

Preview

Command group 'acr pipeline-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List pipeline-runs of all pipelines on a container registry.

az acr pipeline-run list --registry
                         --resource-group
                         [--top]

Examples

List all pipeline-runs on a container registry

az acr pipeline-run list --resource-group $MyRG --registry $MyReg

Required Parameters

--registry -r

Name of registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--top

List only the last n pipeline-runs. Must be an integer.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acr pipeline-run show

Preview

Command group 'acr pipeline-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a pipeline-run in detail.

az acr pipeline-run show --name
                         --registry
                         --resource-group

Examples

Show a specific pipeline-run in detail.

az acr pipeline-run show --resource-group $MyRG --registry $MyReg --name $MyPipelineRun

Required Parameters

--name -n

Name of the pipeline run.

--registry -r

Name of registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.