az blueprint
Note
此參考是 Azure CLI 藍圖延伸模組 的一部分(2.50.0 版或更高版本)。 擴充功能會在您第一次執行 az blueprint 命令時自動安裝。 深入了解擴充功能。
此指令群組已被棄用,將於 2026 年 5 月的下一版重大變更版本(2.86.0)中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
管理藍圖的命令。
命令
| 名稱 | Description | 類型 | 狀態 |
|---|---|---|---|
| az blueprint artifact |
管理藍圖成品的命令。 |
Extension | GA |
| az blueprint artifact delete |
刪除藍圖成品。 |
Extension | Preview |
| az blueprint artifact list |
列出指定藍圖定義的成品。 |
Extension | Preview |
| az blueprint artifact policy |
管理藍圖原則指派成品的命令。 |
Extension | GA |
| az blueprint artifact policy create |
建立藍圖原則成品。 |
Extension | GA |
| az blueprint artifact policy update |
更新藍圖原則成品。 |
Extension | GA |
| az blueprint artifact role |
管理藍圖角色指派成品的命令。 |
Extension | GA |
| az blueprint artifact role create |
建立藍圖角色成品。 |
Extension | GA |
| az blueprint artifact role update |
更新藍圖角色成品。 |
Extension | GA |
| az blueprint artifact show |
取得藍圖成品。 |
Extension | Preview |
| az blueprint artifact template |
管理藍圖 ARM 範本成品的命令。 |
Extension | GA |
| az blueprint artifact template create |
建立藍圖 arm 成品。 |
Extension | GA |
| az blueprint artifact template update |
更新藍圖 arm 成品。 |
Extension | GA |
| az blueprint assignment |
管理藍圖指派的命令。 |
Extension | GA |
| az blueprint assignment create |
建立藍圖指派。 |
Extension | GA |
| az blueprint assignment delete |
刪除藍圖指派。 |
Extension | Preview |
| az blueprint assignment list |
列出訂用帳戶內的藍圖指派。 |
Extension | Preview |
| az blueprint assignment show |
取得藍圖指派。 |
Extension | Preview |
| az blueprint assignment update |
更新藍圖指派。 |
Extension | GA |
| az blueprint assignment wait |
將 CLI 置於等候狀態,直到符合藍圖指派的條件為止。 |
Extension | GA |
| az blueprint assignment who |
取得藍圖 Servie 主體名稱 objectId。 |
Extension | Preview |
| az blueprint create |
建立藍圖定義。 |
Extension | Preview |
| az blueprint delete |
刪除藍圖定義。 |
Extension | Preview |
| az blueprint export |
將藍圖定義和成品導出至 json 檔案(s)。 |
Extension | GA |
| az blueprint import |
從 json 檔案的 directoy 匯入藍圖定義和成品。 |
Extension | GA |
| az blueprint list |
列出藍圖定義。 |
Extension | Preview |
| az blueprint publish |
使用最新的成品發佈新版本的藍圖定義。 已發佈的藍圖定義是不可變的。 |
Extension | Preview |
| az blueprint resource-group |
管理藍圖資源群組成品的命令。 |
Extension | GA |
| az blueprint resource-group add |
將資源群組成品新增至藍圖。 |
Extension | GA |
| az blueprint resource-group list |
列出藍圖資源群組成品。 |
Extension | GA |
| az blueprint resource-group remove |
拿掉藍圖資源群組成品。 |
Extension | GA |
| az blueprint resource-group show |
顯示藍圖資源群組成品。 |
Extension | GA |
| az blueprint resource-group update |
更新藍圖資源群組成品。 |
Extension | GA |
| az blueprint show |
取得藍圖定義。 |
Extension | Preview |
| az blueprint update |
更新藍圖定義。 |
Extension | Preview |
| az blueprint version |
管理已發佈藍圖版本的命令。 |
Extension | Preview |
| az blueprint version artifact |
管理已發佈藍圖成品的命令。 |
Extension | Preview |
| az blueprint version artifact list |
列出已發行藍圖版本的成品。 |
Extension | Preview |
| az blueprint version artifact show |
顯示已發佈藍圖的成品。 |
Extension | Preview |
| az blueprint version delete |
刪除藍圖的已發佈版本。 |
Extension | Preview |
| az blueprint version list |
列出指定藍圖定義的已發佈版本。 |
Extension | Preview |
| az blueprint version show |
取得藍圖的已發佈版本。 |
Extension | Preview |
az blueprint create
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
建立藍圖定義。
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
必要參數
藍圖定義的名稱。
可以指派此藍圖定義的範圍。
| 屬性 | 值 |
|---|---|
| 接受的值: | managementGroup, subscription |
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
多行說明此資源。
單行字串說明此資源。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
此藍圖定義所需的參數。 它可以是 JSON 字串或 JSON 檔案路徑。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
此藍圖定義所定義的資源群組佔位元。 預期值:json-string/@json-file。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint delete
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
刪除藍圖定義。
az blueprint delete --name
[--management-group]
[--subscription]
[--yes]
範例
刪除管理群組藍圖
az blueprint delete --management-group MyManagementGroup --name MyBlueprint
刪除訂用帳戶藍圖
az blueprint delete --subscription MySubscription --name MyBlueprint
必要參數
藍圖定義的名稱。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
請勿提示確認。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint export
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
將藍圖定義和成品導出至 json 檔案(s)。
az blueprint export --name
--output-path
[--management-group]
[--subscription]
[--yes]
範例
匯出藍圖定義和成品
az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"
必要參數
要匯出的藍圖定義名稱。
藍圖和成品 JSON 定義的目錄路徑。 藍圖定義檔案將命名為 blueprint.json。 Artifacts json 檔案將會位於名為 artifacts 的子目錄中。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
略過用戶確認。 設定時,如果目錄不存在,則會建立它。 如果目錄存在且具有內容,則會覆寫它們。 如果未設定,系統會提示用戶繼續許可權。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint import
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
從 json 檔案的 directoy 匯入藍圖定義和成品。
az blueprint import --input-path
--name
[--management-group]
[--subscription]
[--yes]
範例
匯入藍圖定義和成品
az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"
必要參數
藍圖和成品 JSON 定義的目錄路徑。 藍圖定義檔應命名為 blueprint.json。 Artifacts json 檔案應該位於名為 artifacts 的子目錄中。
藍圖定義的名稱。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
請勿提示確認。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint list
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
列出藍圖定義。
az blueprint list [--management-group]
[--max-items]
[--next-token]
[--subscription]
範例
列出管理群組中的藍圖
az blueprint list --management-group MyManagementGroup
列出訂用帳戶中的藍圖
az blueprint list --subscription MySubscription
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的 --next-token 自變數中提供令牌值。
| 屬性 | 值 |
|---|---|
| 參數群組: | Pagination Arguments |
標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。
| 屬性 | 值 |
|---|---|
| 參數群組: | Pagination Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint publish
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
使用最新的成品發佈新版本的藍圖定義。 已發佈的藍圖定義是不可變的。
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
必要參數
藍圖定義的名稱。
已發佈藍圖定義的版本。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
版本特定的變更附註。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint show
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
取得藍圖定義。
az blueprint show --name
[--management-group]
[--subscription]
範例
顯示管理群組藍圖
az blueprint show --management-group MyManagementGroup --name MyBlueprint
顯示訂用帳戶藍圖
az blueprint show --subscription MySubscription --name MyBlueprint
必要參數
藍圖定義的名稱。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az blueprint update
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
此命令已隱含取代,因為命令群組 'az blueprint' 已被取代,且將在未來的版本中移除。 藍圖和相關聯的命令最早將於 2026 年 7 月淘汰。 建議客戶在該日期之後轉移至範本規範和部署堆疊,以支援其應用場景。 遷移文件可以在 https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint取得。
更新藍圖定義。
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}]
必要參數
藍圖定義的名稱。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
多行說明此資源。
單行字串說明此資源。
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
針對藍圖的範圍使用管理群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
此藍圖定義所需的參數。 它可以是 JSON 字串或 JSON 檔案路徑。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove> 或 --remove propertyToRemove。
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
此藍圖定義所定義的資源群組佔位元。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。
指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
針對藍圖的範圍使用訂用帳戶。 如果未指定 --management-group,則會使用 --subscription 值或預設訂用帳戶作為範圍。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource_scope Arguments |
可以指派此藍圖定義的範圍。
| 屬性 | 值 |
|---|---|
| 接受的值: | managementGroup, subscription |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |