az security api-collection apim

預覽

命令群組 'az security api-collection' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

從 Azure API 管理發現、管理並查看 API 集合的安全洞察。

命令

名稱	Description	類型	狀態
az security api-collection apim list	會取得已導入 Microsoft Defender for API 的 API 集合清單。	Core	Preview
az security api-collection apim offboard	Offboard an Azure API 管理 API from Microsoft Defender for APIS. 系統會停止監控 Azure API 管理 API 內的操作，以防有侵入行為。	Core	Preview
az security api-collection apim onboard	Onboard a Azure API 管理 API to Microsoft Defender for APIS. 系統將開始監控 Azure Management API 內的操作，防止入侵行為，並對偵測到的攻擊發出警示。	Core	Preview
az security api-collection apim show	如果已經在 Microsoft Defender for API 上架，則會取得 Azure API 管理 API。如果Azure API 管理 API 被啟用以Microsoft Defender API，系統會監控 Azure API 管理 API 內的操作是否有侵入行為，並對偵測到的攻擊發出警示。	Core	Preview
az security api-collection apim wait	將 CLI 置於等候狀態，直到符合條件為止。	Core	Preview

az security api-collection apim list

編輯

預覽

命令群組 'az security api-collection apim' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

會取得已導入 Microsoft Defender for API 的 API 集合清單。

az security api-collection apim list [--max-items]
                                     [--next-token]
                                     [--resource-group]
                                     [--service-name]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--max-items

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

屬性	值
參數群組:	Pagination Arguments

--next-token

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

屬性	值
參數群組:	Pagination Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--service-name

API 管理服務的名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az security api-collection apim offboard

編輯

預覽

命令群組 'az security api-collection apim' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

Offboard an Azure API 管理 API from Microsoft Defender for APIS. 系統會停止監控 Azure API 管理 API 內的操作，以防有侵入行為。

az security api-collection apim offboard [--acquire-policy-token]
                                         [--api-id --name]
                                         [--change-reference]
                                         [--ids]
                                         [--resource-group]
                                         [--service-name]
                                         [--subscription]
                                         [--yes]

範例

Onboard a Azure API 管理 API to Microsoft Defender for APIS.

az security api-collection apim offboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--api-id --name -n

API 修訂標識碼。 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	Resource Id Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--service-name

API 管理服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az security api-collection apim onboard

編輯

預覽

命令群組 'az security api-collection apim' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

Onboard a Azure API 管理 API to Microsoft Defender for APIS. 系統將開始監控 Azure Management API 內的操作，防止入侵行為，並對偵測到的攻擊發出警示。

az security api-collection apim onboard [--acquire-policy-token]
                                        [--api-id --name]
                                        [--change-reference]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--service-name]
                                        [--subscription]

範例

Onboard a Azure API 管理 API to Microsoft Defender for APIS.

az security api-collection apim onboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--api-id --name -n

API 修訂標識碼。 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	Resource Id Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

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

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--service-name

API 管理服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az security api-collection apim show

編輯

預覽

命令群組 'az security api-collection apim' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

如果已經在 Microsoft Defender for API 上架，則會取得 Azure API 管理 API。如果Azure API 管理 API 被啟用以Microsoft Defender API，系統會監控 Azure API 管理 API 內的操作是否有侵入行為，並對偵測到的攻擊發出警示。

az security api-collection apim show [--api-id --name]
                                     [--ids]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--api-id --name -n

API 修訂標識碼。 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	Resource Id Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--service-name

API 管理服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az security api-collection apim wait

編輯

預覽

命令群組 'az security api-collection apim' 處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

將 CLI 置於等候狀態，直到符合條件為止。

az security api-collection apim wait [--acquire-policy-token]
                                     [--api-id --name]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--api-id --name -n

API 修訂標識碼。 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	Resource Id Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--created

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

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

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

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--ids

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--service-name

API 管理服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？