Share via

Security.ApiCollectionsOnboardAzureApiManagementApi Method

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.Security
Assembly:
Az.Security.private.dll

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.

public System.Threading.Tasks.Task ApiCollectionsOnboardAzureApiManagementApi (string subscriptionId, string resourceGroupName, string serviceName, string apiId, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IApiCollection>,System.Threading.Tasks.Task> onOk, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IErrorResponseAutoGenerated>,System.Threading.Tasks.Task> onDefault, Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.ISendAsync sender);
member this.ApiCollectionsOnboardAzureApiManagementApi : string * string * string * string * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IApiCollection>, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IErrorResponseAutoGenerated>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.ISendAsync -> System.Threading.Tasks.Task
Public Function ApiCollectionsOnboardAzureApiManagementApi (subscriptionId As String, resourceGroupName As String, serviceName As String, apiId As String, onOk As Func(Of HttpResponseMessage, Task(Of IApiCollection), Task), onDefault As Func(Of HttpResponseMessage, Task(Of IErrorResponseAutoGenerated), Task), eventListener As IEventListener, sender As ISendAsync) As Task

Parameters

subscriptionId
String

Azure subscription ID

resourceGroupName
String

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

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.

onOk
Func<HttpResponseMessage,Task<IApiCollection>,Task>

a delegate that is called when the remote service returns 200 (OK).

onDefault
Func<HttpResponseMessage,Task<IErrorResponseAutoGenerated>,Task>

a delegate that is called when the remote service returns default (any response code not handled elsewhere).

eventListener
IEventListener

an IEventListener instance that will receive events.

sender
ISendAsync

an instance of an Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.ISendAsync pipeline to use to make the request.

Returns

Task

A Task that will be complete when handling of the response is completed.

Applies to