az blueprint assignment

注意

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

管理藍圖指派的命令。

命令

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

建立藍圖指派。

az blueprint assignment create --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

範例

使用系統指派的受控識別指派

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type SystemAssigned \
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/provid \
ers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=westus \
--resource-group-value artifact_name=rg-art-2 name=rg2 location=eastus \
--parameters "path/to/parameter/file" \

使用使用者指派的受控識別指派

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type UserAssigned \
--user-assigned-identity "/subscriptions/00000000-0000-0000-0000-000000000000 \
/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"\
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup \
/providers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=eastus \
--parameters "path/to/parameter/file" \

必要參數

--name -n

藍圖指派的名稱。

選擇性參數

--blueprint-version

藍圖定義的已發佈版本資源識別碼。

--description

多行說明此資源。

--display-name

單行字串說明此資源。

--identity-type

受控識別的類型。

接受的值: None, SystemAssigned, UserAssigned

預設值: SystemAssigned

--location -l

位置。​​ 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。

--locks-excluded-principals

從藍圖鎖定排除的 AAD 主體清單。 最多允許 5 個主體。

--locks-mode

鎖定模式。

接受的值: AllResourcesDoNotDelete, AllResourcesReadOnly, None

--management-group -m

針對藍圖指派的目標範圍使用管理群組。 它保留供日後使用。 請改用 --subscription。

--parameters -p

藍圖指派參數值。 它可以是 JSON 字串或 JSON 檔案路徑。

--resource-group-value

資源群組的索引鍵=值組。 索引鍵包括 'artifact_name'（必要）、'name'、'location'。

--subscription -s

針對藍圖指派的目標範圍使用訂用帳戶。 如果未指定選項，則會使用預設 susbcription。

--user-assigned-identity

與資源相關聯的使用者指派受控識別。

全域參數

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

預覽

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

刪除藍圖指派。

az blueprint assignment delete --name
                               [--delete-behavior {all, none}]
                               [--management-group]
                               [--subscription]
                               [--yes]

範例

刪除指派

az blueprint assignment delete --subscription MySubscription --name MyBlueprintAssignment

必要參數

--name -n

藍圖指派的名稱。

選擇性參數

--delete-behavior

當 deleteBehavior=all 時，將會刪除藍圖指派所建立的資源。

接受的值: all, none

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

預覽

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

列出訂用帳戶內的藍圖指派。

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

範例

清單指派

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

預覽

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

取得藍圖指派。

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

範例

顯示指派

az blueprint assignment show --subscription MySubscription --name MyBlueprintAssignment

必要參數

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

更新藍圖指派。

az blueprint assignment update --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

必要參數

--name -n

藍圖指派的名稱。

選擇性參數

--blueprint-version

藍圖定義的已發佈版本資源識別碼。

--description

多行說明此資源。

--display-name

單行字串說明此資源。

--identity-type

受控識別的類型。

接受的值: None, SystemAssigned, UserAssigned

--location -l

位置。​​ 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。

--locks-excluded-principals

從藍圖鎖定排除的 AAD 主體清單。 最多允許 5 個主體。

--locks-mode

鎖定模式。

接受的值: AllResourcesDoNotDelete, AllResourcesReadOnly, None

--management-group -m

針對藍圖指派的目標範圍使用管理群組。 它保留供日後使用。 請改用 --subscription。

--parameters -p

藍圖指派參數值。 它可以是 JSON 字串或 JSON 檔案路徑。

--resource-group-value

資源群組的索引鍵=值組。 索引鍵包括 'artifact_name'（必要）、'name'、'location'。

--subscription -s

針對藍圖指派的目標範圍使用訂用帳戶。 如果未指定選項，則會使用預設 susbcription。

--user-assigned-identity

與資源相關聯的使用者指派受控識別。

全域參數

--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 assignment wait

將 CLI 置於等候狀態，直到符合藍圖指派的條件為止。

az blueprint assignment wait --name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--management-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

範例

暫停執行下一行 CLI 腳本，直到藍圖指派成功布建為止。

az blueprint assignment wait --subscription MySubscription \ --name MyBlueprintAssignment --created

必要參數

--name -n

藍圖指派的名稱。

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--management-group -m

針對藍圖指派的目標範圍使用管理群組。 它保留供日後使用。 請改用 --subscription。

--subscription -s

針對藍圖指派的目標範圍使用訂用帳戶。 如果未指定選項，則會使用預設 susbcription。

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: 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 assignment who

預覽

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

取得藍圖 Servie 主體名稱 objectId。

az blueprint assignment who --name
                            [--management-group]
                            [--subscription]

範例

取得 SPN objectId

az blueprint assignment who --subscription MySubscription --name MyBlueprintAssignment

必要參數

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