ApiCollectionsClient Interface

Package:

com.azure.resourcemanager.security.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-security:1.1.0-beta.1

public interface ApiCollectionsClient

An instance of this class provides access to all the operations defined in ApiCollectionsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<ApiCollectionInner>,ApiCollectionInner>	beginOnboardAzureApiManagementApi(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 SyncPoller<PollResult<ApiCollectionInner>,ApiCollectionInner>	beginOnboardAzureApiManagementApi(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.
abstract ApiCollectionInner	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<ApiCollectionInner>	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<ApiCollectionInner>	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<ApiCollectionInner>	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<ApiCollectionInner>	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<ApiCollectionInner>	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<ApiCollectionInner>	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<ApiCollectionInner>	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 ApiCollectionInner	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 ApiCollectionInner	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

beginOnboardAzureApiManagementApi

public abstract SyncPoller<PollResult<ApiCollectionInner>,ApiCollectionInner> beginOnboardAzureApiManagementApi(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:

the SyncPoller<T,U> for polling of an API collection as represented by Microsoft Defender for APIs.

beginOnboardAzureApiManagementApi

public abstract SyncPoller<PollResult<ApiCollectionInner>,ApiCollectionInner> beginOnboardAzureApiManagementApi(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:

the SyncPoller<T,U> for polling of an API collection as represented by Microsoft Defender for APIs.

getByAzureApiManagementService

public abstract ApiCollectionInner 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 onboarded Azure API Management API Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs.

getByAzureApiManagementServiceWithResponse

public abstract Response<ApiCollectionInner> 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 onboarded Azure API Management API Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs along with Response<T>.

list

public abstract PagedIterable<ApiCollectionInner> 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 Gets 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<ApiCollectionInner> 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 Gets 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<ApiCollectionInner> 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 onboarded Azure API Management APIs Gets 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<ApiCollectionInner> 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 onboarded Azure API Management APIs Gets 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<ApiCollectionInner> 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 Gets 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<ApiCollectionInner> 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 Gets 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<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. 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 ApiCollectionInner 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 ApiCollectionInner 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.