你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

APICollections interface

包:

@azure/arm-security

表示 APICollections 的接口。

方法

beginOnboardAzureApiManagementApi(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)	将 Azure API 管理 API 载入Microsoft Defender API。 系统将开始监视 Azure 管理 API 中的操作，以发现侵入性行为，并为检测到的攻击提供警报。
beginOnboardAzureApiManagementApiAndWait(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)	将 Azure API 管理 API 载入Microsoft Defender API。 系统将开始监视 Azure 管理 API 中的操作，以发现侵入性行为，并为检测到的攻击提供警报。
getByAzureApiManagementService(string, string, string, APICollectionsGetByAzureApiManagementServiceOptionalParams)	获取 Azure API 管理 API（如果已加入 API 的Microsoft Defender）。 如果 Azure API 管理 API 载入到 api Microsoft Defender，系统将监视 Azure API 管理 API 中的操作，以查找侵入性行为，并为检测到的攻击提供警报。
listByAzureApiManagementService(string, string, APICollectionsListByAzureApiManagementServiceOptionalParams)	获取已载入到 api Microsoft Defender 的 Azure API 管理 API 的列表。 如果 Azure API 管理 API 载入到 api Microsoft Defender，系统将监视 Azure API 管理 API 中的操作，以查找侵入性行为，并为检测到的攻击提供警报。
listByResourceGroup(string, APICollectionsListByResourceGroupOptionalParams)	获取资源组中已加入 API Microsoft Defender的 API 集合的列表。
listBySubscription(APICollectionsListBySubscriptionOptionalParams)	获取订阅中已加入 API Microsoft Defender的 API 集合的列表。
offboardAzureApiManagementApi(string, string, string, APICollectionsOffboardAzureApiManagementApiOptionalParams)	从适用于 API 的 Microsoft Defender 卸载 Azure API 管理 API。 系统将停止监视 Azure API 管理 API 中的操作，以阻止入侵行为。

方法详细信息

beginOnboardAzureApiManagementApi(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)

将 Azure API 管理 API 载入Microsoft Defender API。 系统将开始监视 Azure 管理 API 中的操作，以发现侵入性行为，并为检测到的攻击提供警报。

function beginOnboardAzureApiManagementApi(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams): Promise<SimplePollerLike<OperationState<ApiCollection>, ApiCollection>>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 在API 管理服务实例中必须是唯一的。 非当前修订版具有 ;rev=n 作为后缀，其中 n 是修订号。

options

APICollectionsOnboardAzureApiManagementApiOptionalParams

选项参数。

返回

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCollection>, ApiCollection>>

beginOnboardAzureApiManagementApiAndWait(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)

将 Azure API 管理 API 载入Microsoft Defender API。 系统将开始监视 Azure 管理 API 中的操作，以发现侵入性行为，并为检测到的攻击提供警报。

function beginOnboardAzureApiManagementApiAndWait(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams): Promise<ApiCollection>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 在API 管理服务实例中必须是唯一的。 非当前修订版具有 ;rev=n 作为后缀，其中 n 是修订号。

options

APICollectionsOnboardAzureApiManagementApiOptionalParams

选项参数。

返回

Promise<ApiCollection>

getByAzureApiManagementService(string, string, string, APICollectionsGetByAzureApiManagementServiceOptionalParams)

获取 Azure API 管理 API（如果已加入 API 的Microsoft Defender）。 如果 Azure API 管理 API 载入到 api Microsoft Defender，系统将监视 Azure API 管理 API 中的操作，以查找侵入性行为，并为检测到的攻击提供警报。

function getByAzureApiManagementService(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsGetByAzureApiManagementServiceOptionalParams): Promise<ApiCollection>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 在API 管理服务实例中必须是唯一的。 非当前修订版具有 ;rev=n 作为后缀，其中 n 是修订号。

options

APICollectionsGetByAzureApiManagementServiceOptionalParams

选项参数。

返回

Promise<ApiCollection>

listByAzureApiManagementService(string, string, APICollectionsListByAzureApiManagementServiceOptionalParams)

获取已载入到 api Microsoft Defender 的 Azure API 管理 API 的列表。 如果 Azure API 管理 API 载入到 api Microsoft Defender，系统将监视 Azure API 管理 API 中的操作，以查找侵入性行为，并为检测到的攻击提供警报。

function listByAzureApiManagementService(resourceGroupName: string, serviceName: string, options?: APICollectionsListByAzureApiManagementServiceOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

serviceName

string

API 管理服务的名称。

options

APICollectionsListByAzureApiManagementServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

listByResourceGroup(string, APICollectionsListByResourceGroupOptionalParams)

获取资源组中已加入 API Microsoft Defender的 API 集合的列表。

function listByResourceGroup(resourceGroupName: string, options?: APICollectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

options

APICollectionsListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

listBySubscription(APICollectionsListBySubscriptionOptionalParams)

获取订阅中已加入 API Microsoft Defender的 API 集合的列表。

function listBySubscription(options?: APICollectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

参数

options

APICollectionsListBySubscriptionOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>

offboardAzureApiManagementApi(string, string, string, APICollectionsOffboardAzureApiManagementApiOptionalParams)

从适用于 API 的 Microsoft Defender 卸载 Azure API 管理 API。 系统将停止监视 Azure API 管理 API 中的操作，以阻止入侵行为。

function offboardAzureApiManagementApi(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOffboardAzureApiManagementApiOptionalParams): Promise<void>

参数

resourceGroupName

string

资源组的名称。 此名称不区分大小写。

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 在API 管理服务实例中必须是唯一的。 非当前修订版具有 ;rev=n 作为后缀，其中 n 是修订号。

options

APICollectionsOffboardAzureApiManagementApiOptionalParams

选项参数。

返回

Promise<void>