ApiCollections Interface

Package:

com.azure.resourcemanager.security.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-security:1.0.0-beta.6

public interface ApiCollections

Resource collection API of ApiCollections.

Method Summary

Modifier and Type	Method and Description
abstract ApiCollection	getByAzureApiManagementService(String resourceGroupName, String serviceName, String apiId) Gets an onboarded Azure API Management API Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs.
abstract Response<ApiCollection>	getByAzureApiManagementServiceWithResponse(String resourceGroupName, String serviceName, String apiId, Context context) Gets an onboarded Azure API Management API Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	list() Gets a list of API collections within a subscription Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	list(Context context) Gets a list of API collections within a subscription Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	listByAzureApiManagementService(String resourceGroupName, String serviceName) Gets a list of onboarded Azure API Management APIs Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	listByAzureApiManagementService(String resourceGroupName, String serviceName, Context context) Gets a list of onboarded Azure API Management APIs Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	listByResourceGroup(String resourceGroupName) Gets a list of API collections within a resource group Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.
abstract PagedIterable<ApiCollection>	listByResourceGroup(String resourceGroupName, Context context) Gets a list of API collections within a resource group Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.
abstract void	offboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId) Offboard an Azure API Management API from Microsoft Defender for APIs Offboard an Azure API Management API from Microsoft Defender for APIs.
abstract Response<Void>	offboardAzureApiManagementApiWithResponse(String resourceGroupName, String serviceName, String apiId, Context context) Offboard an Azure API Management API from Microsoft Defender for APIs Offboard an Azure API Management API from Microsoft Defender for APIs.
abstract ApiCollection	onboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId) Onboard an Azure API Management API to Microsoft Defender for APIs Onboard an Azure API Management API to Microsoft Defender for APIs.
abstract ApiCollection	onboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId, Context context) Onboard an Azure API Management API to Microsoft Defender for APIs Onboard an Azure API Management API to Microsoft Defender for APIs.

Method Details

getByAzureApiManagementService

public abstract ApiCollection getByAzureApiManagementService(String resourceGroupName, String serviceName, String apiId)

Gets an onboarded Azure API Management API 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Returns:

an Azure API Management API if it has been onboarded to Microsoft Defender for APIs.

getByAzureApiManagementServiceWithResponse

public abstract Response getByAzureApiManagementServiceWithResponse(String resourceGroupName, String serviceName, String apiId, Context context)

Gets an onboarded Azure API Management API 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

context - The context to associate with this operation.

Returns:

an Azure API Management API if it has been onboarded to Microsoft Defender for APIs along with Response<T>.

list

public abstract PagedIterable list()

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

Returns:

a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(Context context)

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

Parameters:

context - The context to associate with this operation.

Returns:

a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

listByAzureApiManagementService

public abstract PagedIterable listByAzureApiManagementService(String resourceGroupName, String serviceName)

Gets a list of onboarded Azure API Management APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

listByAzureApiManagementService

public abstract PagedIterable listByAzureApiManagementService(String resourceGroupName, String serviceName, Context context)

Gets a list of onboarded Azure API Management APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs as paginated response with PagedIterable<T>.

offboardAzureApiManagementApi

public abstract void offboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId)

Offboard an Azure API Management API from Microsoft Defender for APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

offboardAzureApiManagementApiWithResponse

public abstract Response offboardAzureApiManagementApiWithResponse(String resourceGroupName, String serviceName, String apiId, Context context)

Offboard an Azure API Management API from Microsoft Defender for APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

context - The context to associate with this operation.

Returns:

the Response<T>.

onboardAzureApiManagementApi

public abstract ApiCollection onboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId)

Onboard an Azure API Management API to Microsoft Defender for APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Returns:

an API collection as represented by Microsoft Defender for APIs.

onboardAzureApiManagementApi

public abstract ApiCollection onboardAzureApiManagementApi(String resourceGroupName, String serviceName, String apiId, Context context)

Onboard an Azure API Management API to Microsoft Defender for APIs 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

context - The context to associate with this operation.

Returns:

an API collection as represented by Microsoft Defender for APIs.