APICollectionsOperations interface

Package:: @azure/arm-security

Interface representing a APICollections operations.

Properties

beginOnboardAzureApiManagementApi
beginOnboardAzureApiManagementApiAndWait
getByAzureApiManagementService	Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.
listByAzureApiManagementService	Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.
listByResourceGroup	Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.
listBySubscription	Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
offboardAzureApiManagementApi	Offboard an Azure API Management API from Microsoft Defender for APIs. The system will stop monitoring the operations within the Azure API Management API for intrusive behaviors.
onboardAzureApiManagementApi	Onboard an Azure API Management API to Microsoft Defender for APIs. The system will start monitoring the operations within the Azure Management API for intrusive behaviors and provide alerts for attacks that have been detected.

Property Details

beginOnboardAzureApiManagementApi

Warning

This API is now deprecated.

use onboardAzureApiManagementApi instead

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

Property Value

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

beginOnboardAzureApiManagementApiAndWait

Warning

This API is now deprecated.

use onboardAzureApiManagementApi instead

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

Property Value

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

getByAzureApiManagementService

Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.

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

Property Value

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

listByAzureApiManagementService

Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.

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

Property Value

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

listByResourceGroup

Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.

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

Property Value

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

listBySubscription

Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.

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

Property Value

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

offboardAzureApiManagementApi

Offboard an Azure API Management API from Microsoft Defender for APIs. The system will stop monitoring the operations within the Azure API Management API for intrusive behaviors.

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

Property Value

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

onboardAzureApiManagementApi

Onboard an Azure API Management API to Microsoft Defender for APIs. The system will start monitoring the operations within the Azure Management API for intrusive behaviors and provide alerts for attacks that have been detected.

onboardAzureApiManagementApi: (resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams) => PollerLike<OperationState<ApiCollection>, ApiCollection>

Property Value

(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams) => PollerLike<OperationState<ApiCollection>, ApiCollection>

Feedback

Was this page helpful?