az alias

  • 參考

注意

此參考是 Azure CLI 的別名 延伸模組的一部分 （2.0.31.dev0 版或更高版本）。 擴充功能會在您第一次執行 az alias 命令時自動安裝。 深入了解擴充功能。

管理 Azure CLI 別名。

命令

名稱 Description 類型 狀態
az alias create

建立別名。

 擴充 GA
az alias export

將所有已註冊的別名匯出至指定的路徑，作為 INI 組態檔。 如果未指定匯出路徑，別名組態檔就會匯出至目前的工作目錄。

 擴充 GA
az alias import

從 INI 組態檔或 URL 匯入別名。

 擴充 GA
az alias list

列出已註冊的別名。

 擴充 GA
az alias remove

移除一或多個別名。 要移除的別名會以空格分隔。

 擴充 GA
az alias remove-all

移除所有已註冊的別名。

 擴充 GA

az alias create

建立別名。

az alias create --command
                --name

範例

建立簡單的別名命令。

az alias create --name rg --command group

az alias create --name ls --command list

建立複雜的別名。

az alias create --name list-vm --command 'vm list --resource-group myResourceGroup'

使用引數建立別名命令。

az alias create --name 'list-vm {{ resource_group }}' \
  --command 'vm list --resource-group {{ resource_group }}'

使用 Jinja2 範本處理引數。

az alias create --name 'storage-ls {{ url }}' \
  --command 'storage blob list
    --account-name {{ url.replace("https://", "").split(".")[0] }}
    --container-name {{ url.replace("https://", "").split("/")[1] }}'

必要參數

--command -c

別名指向的命令。

--name -n

別名的名稱。

全域參數
--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 alias export

將所有已註冊的別名匯出至指定的路徑，作為 INI 組態檔。 如果未指定匯出路徑，別名組態檔就會匯出至目前的工作目錄。

az alias export [--exclude]
                [--path]

選擇性參數

--exclude -e

從匯出排除的空間分隔別名。

--path -p

要匯出的別名組態檔路徑。

全域參數
--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 alias import

從 INI 組態檔或 URL 匯入別名。

az alias import --source

必要參數

--source -s

要匯入的來源別名。

全域參數
--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 alias list

列出已註冊的別名。

az alias list
全域參數
--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 alias remove

移除一或多個別名。 要移除的別名會以空格分隔。

az alias remove --name

必要參數

--name -n

以空格分隔的別名。

全域參數
--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 alias remove-all

移除所有已註冊的別名。

az alias remove-all [--yes]

選擇性參數

--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 來取得完整偵錯記錄。