Please explain what --run-id is

[RickKra]

The --run-id parameter is required on all these commands, but nowhere do you explain what one is or give an example that shows what one would look like.

Please add those details.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 4e1f25b5-397e-03b6-7d7f-75570d8649e5
• Version Independent ID: 962e2f0c-ce31-7de7-8222-17ceeac1dc98
• Content: az pipelines runs artifact
• Content Source: latest/docs-ref-autogen/ext/azure-devops/pipelines/runs/artifact.yml
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

[atbagga]

@RickKra

You will be able to better map these commands and inputs to UI if you have the preview feature enabled as below -

If above feature is NOT enabled on your account, you can think of --run-id as --build-id

az pipelines commands like list, show, create, delete help you manage the pipeline definitions.
az pipelines runs commands help you manage pipeline runs for those definitions.

e.g. az pipelines list

az pipelines runs list

Hence --run-id is the pipeline runs identifier which might be listed in your url as --build-id https://dev.azure.com/MyOrganization/MyProject/_build/results?buildId=984&view=results

Please let me know if this helps.
We will try to fix the documentation for this in command help.

[atbagga]

@geverghe Please suggest how we can improve the help text to fix the issue.

[geverghe]

@RickKra - Would the following update work?

1. "ID of the run that the artifact is associated to. For example, --run-id 1"

[RickKra]

@atbagga your 1st comment where you explain that run-id and build-id (or release-id as well?) are equivalent and show where to find those values is what I was after.

@geverghe no that update wouldn't work, because it's a fabricated value. I wanted to understand what it is and where I'd find the values that I'd want to use with those commands.

[geverghe]

@RickKra
Addressing feedback on "what it is"
Isn't "--run - ID of the run that the artifact is associated to." adequate for understanding what it is? Which part requires more clarity or is confusing? Would mentioning "ID of the pipeline run that the artifact is associated to." help?

Addressing feedback on "where I'd find the values to use with those commands"
For all ID related parameters, the paradigm followed is that the list command gives the ID which is to be used in the show command. Therefore, az pipelines runs show would require the ID which is fetched from az pipelines runs list. This is a consistent paradigm followed in Azure CLI. To clarify, are you facing a challenge in this paradigm or only for this specific command? This helps us evaluate if the change required is widespread or limited to just this command.

In case you want to continue the conversation on mail, you can reach me at geverghe at microsoft dot com.

[atbagga]

@RickKra Resolving the issue since it is a learning curve for using some of the commands and new terminology with the pipelines revamp. For any concerns/feedback please reach out to George as per his comment above and we will be happy to help.