az blueprint

注意

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

管理藍圖的命令。

命令

名稱	Description	類型	狀態
az blueprint artifact	管理藍圖成品的命令。	擴充	GA
az blueprint artifact delete	刪除藍圖成品。	擴充	預覽版
az blueprint artifact list	列出指定藍圖定義的成品。	擴充	預覽版
az blueprint artifact policy	管理藍圖原則指派成品的命令。	擴充	GA
az blueprint artifact policy create	建立藍圖原則成品。	擴充	GA
az blueprint artifact policy update	更新藍圖原則成品。	擴充	GA
az blueprint artifact role	管理藍圖角色指派成品的命令。	擴充	GA
az blueprint artifact role create	建立藍圖角色成品。	擴充	GA
az blueprint artifact role update	更新藍圖角色成品。	擴充	GA
az blueprint artifact show	取得藍圖成品。	擴充	預覽版
az blueprint artifact template	管理藍圖 ARM 範本成品的命令。	擴充	GA
az blueprint artifact template create	建立藍圖 arm 成品。	擴充	GA
az blueprint artifact template update	更新藍圖 arm 成品。	擴充	GA
az blueprint assignment	管理藍圖指派的命令。	擴充	GA
az blueprint assignment create	建立藍圖指派。	擴充	GA
az blueprint assignment delete	刪除藍圖指派。	擴充	預覽版
az blueprint assignment list	列出訂用帳戶內的藍圖指派。	擴充	預覽版
az blueprint assignment show	取得藍圖指派。	擴充	預覽版
az blueprint assignment update	更新藍圖指派。	擴充	GA
az blueprint assignment wait	將 CLI 置於等候狀態，直到符合藍圖指派的條件為止。	擴充	GA
az blueprint assignment who	取得藍圖 Servie 主體名稱 objectId。	擴充	預覽版
az blueprint create	建立藍圖定義。	擴充	預覽版
az blueprint delete	刪除藍圖定義。	擴充	預覽版
az blueprint export	將藍圖定義和成品匯出至 json 檔案（s）。	擴充	GA
az blueprint import	從 json 檔案的 directoy 匯入藍圖定義和成品。	擴充	GA
az blueprint list	列出藍圖定義。	擴充	預覽版
az blueprint publish	使用最新的成品發佈新版本的藍圖定義。 已發佈的藍圖定義是不可變的。	擴充	預覽版
az blueprint resource-group	管理藍圖資源群組成品的命令。	擴充	GA
az blueprint resource-group add	將資源群組成品新增至藍圖。	擴充	GA
az blueprint resource-group list	列出藍圖資源群組成品。	擴充	GA
az blueprint resource-group remove	移除藍圖資源群組成品。	擴充	GA
az blueprint resource-group show	顯示藍圖資源群組成品。	擴充	GA
az blueprint resource-group update	更新藍圖資源群組成品。	擴充	GA
az blueprint show	取得藍圖定義。	擴充	預覽版
az blueprint update	更新藍圖定義。	擴充	預覽版
az blueprint version	管理已發佈藍圖版本的命令。	擴充	預覽版
az blueprint version artifact	管理已發佈藍圖成品的命令。	擴充	預覽版
az blueprint version artifact list	列出已發行藍圖版本的成品。	擴充	預覽版
az blueprint version artifact show	顯示已發佈藍圖的成品。	擴充	預覽版
az blueprint version delete	刪除藍圖的已發佈版本。	擴充	預覽版
az blueprint version list	列出指定藍圖定義的已發佈版本。	擴充	預覽版
az blueprint version show	取得藍圖的已發佈版本。	擴充	預覽版

az blueprint create

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立藍圖定義。

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

範例

建立訂用帳戶藍圖

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

建立管理群組藍圖

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

必要參數

--name -n

藍圖定義的名稱。

--target-scope

可以指派此藍圖定義的範圍。

接受的值: managementGroup, subscription

選擇性參數

--description

多行說明此資源。

--display-name

單行字串說明此資源。

--management-group -m

針對藍圖的範圍使用管理群組。

--parameters -p

此藍圖定義所需的參數。 它可以是 JSON 字串或 JSON 檔案路徑。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--resource-groups

此藍圖定義所定義的資源群組預留位置。 預期值：json-string/@json-file。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

全域參數

--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 blueprint delete

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除藍圖定義。

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

範例

刪除管理群組藍圖

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

刪除訂用帳戶藍圖

az blueprint delete --subscription MySubscription --name MyBlueprint

必要參數

--name -n

藍圖定義的名稱。

選擇性參數

--management-group -m

針對藍圖的範圍使用管理群組。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

--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 blueprint export

將藍圖定義和成品匯出至 json 檔案（s）。

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

範例

匯出藍圖定義和成品

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

必要參數

--name -n

要匯出的藍圖定義名稱。

--output-path

藍圖和成品 JSON 定義的目錄路徑。 藍圖定義檔案將會命名為 blueprint.json。 Artifacts json 檔案將會位於名為 artifacts 的子目錄中。

選擇性參數

--management-group -m

針對藍圖的範圍使用管理群組。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

--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 blueprint import

從 json 檔案的 directoy 匯入藍圖定義和成品。

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

範例

匯入藍圖定義和成品

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

必要參數

--input-path

藍圖和成品 JSON 定義的目錄路徑。 藍圖定義檔案應命名為 blueprint.json。 Artifacts json 檔案應該位於名為 artifacts 的子目錄中。

--name -n

藍圖定義的名稱。

選擇性參數

--management-group -m

針對藍圖的範圍使用管理群組。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

--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 blueprint list

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出藍圖定義。

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

範例

列出管理群組中的藍圖

az blueprint list --management-group MyManagementGroup

列出訂用帳戶中的藍圖

az blueprint list --subscription MySubscription

選擇性參數

--management-group -m

針對藍圖的範圍使用管理群組。

--max-items

命令輸出中要傳回的專案總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供權杖。 若要繼續分頁，請在後續命令的引數中 --next-token 提供權杖值。

--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的權杖值。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

全域參數

--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 blueprint publish

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

使用最新的成品發佈新版本的藍圖定義。 已發佈的藍圖定義是不可變的。

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

範例

發佈管理群組藍圖

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

發佈訂用帳戶藍圖

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

必要參數

--blueprint-name

藍圖定義的名稱。

--version

已發佈藍圖定義的版本。

選擇性參數

--change-notes

版本特定的變更附注。

--management-group -m

針對藍圖的範圍使用管理群組。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

全域參數

--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 blueprint show

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得藍圖定義。

az blueprint show --name
                  [--management-group]
                  [--subscription]

範例

顯示管理群組藍圖

az blueprint show --management-group MyManagementGroup --name MyBlueprint

顯示訂用帳戶藍圖

az blueprint show --subscription MySubscription --name MyBlueprint

必要參數

--name -n

藍圖定義的名稱。

選擇性參數

--management-group -m

針對藍圖的範圍使用管理群組。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

全域參數

--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 blueprint update

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新藍圖定義。

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

必要參數

--name -n

藍圖定義的名稱。

選擇性參數

--add

藉由指定路徑和索引鍵值組，將 物件加入物件清單。 範例：--add property.listProperty < key=value、string 或 JSON 字串 > 。

--description

多行說明此資源。

--display-name

單行字串說明此資源。

--force-string

使用 'set' 或 'add' 時，請保留字元串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--management-group -m

針對藍圖的範圍使用管理群組。

--parameters -p

此藍圖定義所需的參數。 它可以是 JSON 字串或 JSON 檔案路徑。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--remove

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--resource-groups

此藍圖定義所定義的資源群組預留位置。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--subscription -s

針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group，則會使用 --subscription 值或預設訂用帳戶作為範圍。

--target-scope

可以指派此藍圖定義的範圍。

接受的值: managementGroup, subscription

全域參數

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