APICollections interface
Interface representing a APICollections.
Methods
| begin |
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. |
| begin |
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. |
| get |
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. |
| list |
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. |
| list |
Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs. |
| list |
Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs. |
| offboard |
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. |
Method Details
beginOnboardAzureApiManagementApi(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)
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.
function beginOnboardAzureApiManagementApi(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams): Promise<SimplePollerLike<OperationState<ApiCollection>, ApiCollection>>Parameters
- 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCollection>, ApiCollection>>
beginOnboardAzureApiManagementApiAndWait(string, string, string, APICollectionsOnboardAzureApiManagementApiOptionalParams)
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.
function beginOnboardAzureApiManagementApiAndWait(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOnboardAzureApiManagementApiOptionalParams): Promise<ApiCollection>Parameters
- 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.
The options parameters.
Returns
Promise<ApiCollection>
getByAzureApiManagementService(string, string, string, APICollectionsGetByAzureApiManagementServiceOptionalParams)
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.
function getByAzureApiManagementService(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsGetByAzureApiManagementServiceOptionalParams): Promise<ApiCollection>Parameters
- 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.
The options parameters.
Returns
Promise<ApiCollection>
listByAzureApiManagementService(string, string, APICollectionsListByAzureApiManagementServiceOptionalParams)
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.
function listByAzureApiManagementService(resourceGroupName: string, serviceName: string, options?: APICollectionsListByAzureApiManagementServiceOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
listByResourceGroup(string, APICollectionsListByResourceGroupOptionalParams)
Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.
function listByResourceGroup(resourceGroupName: string, options?: APICollectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(APICollectionsListBySubscriptionOptionalParams)
Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
function listBySubscription(options?: APICollectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ApiCollection, ApiCollection[], PageSettings>Parameters
The options parameters.
Returns
offboardAzureApiManagementApi(string, string, string, APICollectionsOffboardAzureApiManagementApiOptionalParams)
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.
function offboardAzureApiManagementApi(resourceGroupName: string, serviceName: string, apiId: string, options?: APICollectionsOffboardAzureApiManagementApiOptionalParams): Promise<void>Parameters
- 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.
The options parameters.
Returns
Promise<void>
Azure SDK for JavaScript