SecurityCenterExtensions.GetSecurityCenterApiCollectionAsync Method

Definition

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/providers/Microsoft.Security/apiCollections/{apiId}
  • Operation Id: APICollections_GetByAzureApiManagementService
  • Default Api Version: 2023-11-15
  • Resource: SecurityCenterApiCollectionResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityCenterApiCollectionResource>> GetSecurityCenterApiCollectionAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string serviceName, string apiId, System.Threading.CancellationToken cancellationToken = default);
static member GetSecurityCenterApiCollectionAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityCenterApiCollectionResource>>
<Extension()>
Public Function GetSecurityCenterApiCollectionAsync (resourceGroupResource As ResourceGroupResource, serviceName As String, apiId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SecurityCenterApiCollectionResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

serviceName
String

The name of the API Management service.

apiId
String

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.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource, serviceName or apiId is null.

serviceName or apiId is an empty string, and was expected to be non-empty.

Applies to