你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az pipelines variable

注意

此参考是 Azure CLI(版本 2.30.0 或更高版本)的 azure-devops 扩展的一部分。 该扩展将在首次运行 az pipelines variable 命令时自动安装。 详细了解扩展。

管理管道变量。

命令

名称 说明 类型 状态
az pipelines variable create

将变量添加到管道。

分机 GA
az pipelines variable delete

从管道中删除变量。

分机 GA
az pipelines variable list

列出管道中的变量。

分机 GA
az pipelines variable update

更新管道中的变量。

分机 GA

az pipelines variable create

将变量添加到管道。

az pipelines variable create --name
                             [--allow-override {false, true}]
                             [--detect {false, true}]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--secret {false, true}]
                             [--value]

必需参数

--name

变量的名称。

可选参数

--allow-override

指示是否可以在队列时设置值。

接受的值: false, true
--detect

自动检测组织。

接受的值: false, true
--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取,则为必需。示例:https://dev.azure.com/MyOrganizationName/

--pipeline-id

管道的 ID。

--pipeline-name

管道的名称。 如果提供了 --pipeline-id 参数,则忽略。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取,则为必需。

--secret

指示变量的值是否为机密。

接受的值: false, true
--value

变量的值。 对于机密变量,如果未提供 --value 参数,则会从带有AZURE_DEVOPS_EXT_PIPELINE_VAR_前缀的环境变量中选取它,否则系统会提示用户通过标准输入输入它。 例如,命名的变量 MySecret 可以使用环境变量AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret进行输入。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az pipelines variable delete

从管道中删除变量。

az pipelines variable delete --name
                             [--detect {false, true}]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--yes]

必需参数

--name

要删除的变量的名称。

可选参数

--detect

自动检测组织。

接受的值: false, true
--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取,则为必需。示例:https://dev.azure.com/MyOrganizationName/

--pipeline-id

管道的 ID。

--pipeline-name

管道的名称。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取,则为必需。

--yes -y

不提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az pipelines variable list

列出管道中的变量。

az pipelines variable list [--detect {false, true}]
                           [--org]
                           [--pipeline-id]
                           [--pipeline-name]
                           [--project]

可选参数

--detect

自动检测组织。

接受的值: false, true
--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取,则为必需。示例:https://dev.azure.com/MyOrganizationName/

--pipeline-id

管道的 ID。

--pipeline-name

管道的名称。 如果提供了 --pipeline-id 参数,则忽略。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取,则为必需。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az pipelines variable update

更新管道中的变量。

az pipelines variable update --name
                             [--allow-override {false, true}]
                             [--detect {false, true}]
                             [--new-name]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--prompt-value {false, true}]
                             [--secret {false, true}]
                             [--value]

必需参数

--name

变量的名称。

可选参数

--allow-override

指示是否可以在队列时设置值。

接受的值: false, true
--detect

自动检测组织。

接受的值: false, true
--new-name

变量的新名称。

--org --organization

Azure DevOps 组织 URL。 可以使用 az devops configure -d organization=ORG_URL 配置默认组织。 如果未配置为默认或未通过 git 配置选取,则为必需。示例:https://dev.azure.com/MyOrganizationName/

--pipeline-id

管道的 ID。

--pipeline-name

管道的名称。 如果提供了 --pipeline-id 参数,则忽略。

--project -p

项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取,则为必需。

--prompt-value

将其设置为 True 以使用环境变量或通过标准输入提示更新机密变量的值。

接受的值: false, true
--secret

如果变量的值是机密。

接受的值: false, true
--value

变量的新值。 对于机密变量,请使用 --prompt-value 参数,提示通过标准输入输入它。 对于非交互式控制台,可以从带有AZURE_DEVOPS_EXT_PIPELINE_VAR_前缀的环境变量中进行选择,例如,可以使用环境变量AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret输入变量 MySecret

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。