MockableSecurityCenterArmClient.GetApiCollectionAsync 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.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.ApiCollectionResource>> GetApiCollectionAsync(Azure.Core.ResourceIdentifier scope, string apiId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetApiCollectionAsync : Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.ApiCollectionResource>>
override this.GetApiCollectionAsync : Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.ApiCollectionResource>>
Public Overridable Function GetApiCollectionAsync (scope As ResourceIdentifier, apiId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiCollectionResource))

Parameters

scope
ResourceIdentifier

The scope of the resource collection to get.

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

apiId is null.

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

Applies to