教學課程:使用保存的參數來簡化連續的 Azure CLI 命令

Azure CLI 提供保存的參數,可讓您儲存參數值以便後續使用。 在本教學課程中,您將了解如何使用保存的值,並使用這些本機值來有效率地執行連續命令。

在本教學課程中,您將了解:

  • 使用 az config param-persist 參考命令
  • 使用保存的參數執行連續命令

本教學課程使用下列 Azure CLI 命令

如果您沒有 Azure 訂用帳戶,請在開始前建立免費帳戶

Prerequisites

  1. 安裝 Azure CLI

    您也可以使用 Azure Cloud Shell 來完成本教學課程中的步驟。 Azure Cloud Shell 是互動式殼層環境,可在瀏覽器中使用。 使用下列其中一種方法啟動 Cloud Shell:

  2. 如果您使用 Azure CLI 的本機安裝,請完成下列步驟:

    • 使用 az login 命令登入,然後遵循終端中顯示的步驟來完成驗證程序。

      az login
      
    • 本教學課程需要 2.12.0 版或更新版本的 Azure CLI。 執行 az version 以尋找已安裝的版本和相依程式庫。 若要升級至最新版本,請執行 az upgrade

1.判斷您的本機目錄

持續性參數值會儲存在 Azure Cloud Shell 所使用的 Azure 儲存體帳戶工作目錄中。 如果您使用 Azure CLI 的本機安裝,則值會儲存在您機器上的工作目錄中。

若要尋找、建立或變更 Azure CLI 所使用的工作目錄,請使用這些熟悉的 CLI 命令。

# List directories
dir

# Make directory
mkdir azCLI

# Change directory
cd azCLI

2.開啟保存的參數

必須先開啟保存的參數才能儲存參數值。 您將會收到警告,直到 az config param-persist 移出實驗階段為止。 請參閱概觀:Azure CLI 參考型別和狀態,以了解 Azure CLI 參考型別、狀態和支援層級。

az config param-persist on

3.建立保存的參數

若要儲存保存參數的值,請執行您選擇的 Azure CLI 命令,其中包含您想要儲存的參數。 例如,建立資源群組,並 --location 儲存 和 --name 參數以供日後使用。

  1. 儲存位置和資源群組名稱。

    # With persisted parameters turned on, create a resource group
    az group create --name RG1forTutorial --location eastus2
    
    # See new persisted parameters
    az config param-persist show
    
    {
      "all": {
        "location": "eastus2",
        "resource_group_name": "RG1forTutorial"
      }
    }
    
  2. 使用新的保存參數,建立儲存體帳戶。

    # Create a storage account
    az storage account create --name sa1fortutorial
    
    # See that storage_account_name has been added to persisted parameters
    az config param-persist show
    
    {
      "all": {
        "location": "eastus2",
        "resource_group_name": "RG1forTutorial",
        "storage_account_name": "sa1fortutorial"
      }
    }
    
  3. 建立保存的參數,而不建立新的資源。

    如果您不想建立新的 Azure 資源, resource_group_name 而且 location 參數可以使用 或 list 之類的 show 非建立命令來儲存。 如需支援參數的完整清單,以及保留值所需的動作,請參閱 Azure CLI 保存的參數 。 此範例也會使用 az config param-persist delete 命令來移除所有參數值。

    # Clear all persisted parameters for demonstration.
    az config param-persist delete --all
    
    # List all storage accounts which will create the `resource_group_name` stored parameter value.
    az storage account show --resource-group RG1forTutorial --name sa1fortutorial
    
    # See the new stored value created for resource group.  The storage account name is only stored with a 'create' command.
    az config param-persist show
    
    {
      "all": {
        "resource_group_name": "RG1forTutorial"
      }
    }
    

4.取代保存的參數

取代儲存的參數值就像執行包含不同值的命令一樣簡單。

  1. 建立新的保存參數。

    # Clear all persisted parameters for demonstration
    az config param-persist delete --all
    
    # Create a storage account placing "location", "resource_group_name", and "storage_account_name" into persisted parameters
    az storage account create --name sa1fortutorial --resource-group RG1forTutorial --location eastus2
    
    # See persisted parameters entries
    az config param-persist show
    
    {
      "all": {
        "location": "eastus2",
        "resource_group_name": "RG1forTutorial",
        "storage_account_name": "sa1fortutorial"
      }
    }
    
  2. 取代新儲存的值。

    # Create a second storage account while changing both the "storage_account_name" and "location" persisted parameters
    az storage account create --name sa2fortutorial --location westeurope
    
    # See new persisted parameters
    az config param-persist show
    
    {
      "all": {
        "location": "westeurope",
        "resource_group_name": "RG1forTutorial",
        "storage_account_name": "sa2fortutorial"
      }
    }
    

    注意

    即使已開啟保存的參數,您也不一定要使用這些參數。 您仍然可以使用所有指定的參數值來執行命令。 不過,請注意,開啟保存的參數後,您將會建立新的保存參數,或覆寫現有的參數。

5.執行連續命令

這些指令碼會使用取用方案建立 Azure 函式應用程式。

# Reminder: function app and storage account names must be unique.

# Turn persisted parameters on.
az config param-persist on

# Create a resource group.
az group create --name RG2forTutorial --location westeurope

# Create an Azure storage account in the resource group omitting "--location" and "--resource-group" parameters.
az storage account create \
  --name sa3fortutorial \
  --sku Standard_LRS

# Create a serverless function app in the resource group omitting "--storage-account" and "--resource-group" parameters.
az functionapp create \
  --name FAforTutorial \
  --consumption-plan-location westeurope \
  --functions-version 2

# See the stored parameter values.
az config param-persist show

6.刪除保存的參數

使用 az config param-persist delete 命令來移除項目。

# Remove a single persisted parameters entry by specifying the name, not the value
az config param-persist delete resource_group_name

# Remove all persisted parameters entries and do not prompt for confirmation
az config param-persist delete --all --yes

重要

如果刪除 Azure 資源,即不會更新保存的參數。

# delete a resource group
az group delete --name RG1forTutorial

# verify that the resource group no longer exists
az group list --output table

# See that the resource group name remains in persisted parameters
az config param-persist show

7.關閉保存的參數

您可以使用 az config param-persist off 命令關閉保存的參數,但不會刪除已儲存的保存參數資料。

# Turn persisted parameters off
az config param-persist off

# See that your persisted parameters still exist
az config param-persist show

# Try to create a new resource relying on persisted parameters and receive error "...the following arguments are required:..."
az storage account create --name SA4inAzCLI --sku Standard_LRS

8.清除資源

若不再需要,請使用 az group delete 命令來移除資源群組和所有相關資源。

az group delete --name RG1forTutorial

請參閱