Package com.azure.resourcemanager.security.fluent

Interface ApiCollectionsClient

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

  • Method Summary

    Modifier and Type
    Method
    Description
    ApiCollectionResponseInner
    get(String resourceGroupName, String serviceName, String apiCollectionId)
    Gets an Azure API Management API if it has been onboarded to Defender for APIs
    com.azure.core.http.rest.Response<ApiCollectionResponseInner>
    getWithResponse(String resourceGroupName, String serviceName, String apiCollectionId, com.azure.core.util.Context context)
    Gets an Azure API Management API if it has been onboarded to Defender for APIs
    com.azure.core.http.rest.PagedIterable<ApiCollectionResponseInner>
    list(String resourceGroupName, String serviceName)
    Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs
    com.azure.core.http.rest.PagedIterable<ApiCollectionResponseInner>
    list(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
    Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ApiCollectionResponseInner> list(String resourceGroupName, String serviceName)
      Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs

      Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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 Defender for APIs as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<ApiCollectionResponseInner> list(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs

      Gets a list of Azure API Management APIs that have been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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 Defender for APIs as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<ApiCollectionResponseInner> getWithResponse(String resourceGroupName, String serviceName, String apiCollectionId, com.azure.core.util.Context context)
      Gets an Azure API Management API if it has been onboarded to Defender for APIs

      Gets an Azure API Management API if it has been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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.
      apiCollectionId - A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
      context - The context to associate with this operation.
      Returns:
      an Azure API Management API if it has been onboarded to Defender for APIs along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      ApiCollectionResponseInner get(String resourceGroupName, String serviceName, String apiCollectionId)
      Gets an Azure API Management API if it has been onboarded to Defender for APIs

      Gets an Azure API Management API if it has been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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.
      apiCollectionId - A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
      Returns:
      an Azure API Management API if it has been onboarded to Defender for APIs.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.