az pipelines variable

注意

此參考是 Azure CLI 的 azure-devops 延伸模組的一部分 （2.30.0 版或更高版本）。 擴充功能會在您第一次執行 az pipelines variable 命令時自動安裝。 深入了解擴充功能。

管理管線變數。

命令

名稱	Description	類型	狀態
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

管線的識別碼。

--pipeline-name

管線的名稱。 如果提供 --pipeline-id 參數，則會忽略 。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

管線的識別碼。

--pipeline-name

管線的名稱。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

管線的識別碼。

--pipeline-name

管線的名稱。 如果提供 --pipeline-id 參數，則會忽略 。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

管線的識別碼。

--pipeline-name

管線的名稱。 如果提供 --pipeline-id 參數，則會忽略 。

--project -p

專案的名稱或識別碼。 您可以使用 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_ 的環境變數中挑選，例如，名稱 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。