api_collections

Creates, updates, deletes, gets or lists a api_collections resource.

Overview

Name	api_collections
Type	Resource
Id	azure.security.api_collections

Fields

vw_api_collections

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
apiId	text	field from the properties object
base_url	text	field from the properties object
discovered_via	text	field from the properties object
display_name	text	field from the properties object
number_of_api_endpoints	text	field from the properties object
number_of_api_endpoints_with_sensitive_data_exposed	text	field from the properties object
number_of_external_api_endpoints	text	field from the properties object
number_of_inactive_api_endpoints	text	field from the properties object
number_of_unauthenticated_api_endpoints	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sensitivity_label	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Resource type

api_collections

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	Describes the properties of an API collection.
type	string	Resource type

Methods

Name	Accessible by	Required Params	Description
get_by_azure_api_management_service	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	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_by_azure_api_management_service	SELECT	resourceGroupName, serviceName, subscriptionId	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_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of API collections within a resource group that have been onboarded to Microsoft Defender for APIs.
list_by_subscription	SELECT	subscriptionId	Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
offboard_azure_api_management_api	EXEC	apiId, resourceGroupName, serviceName, subscriptionId	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.
onboard_azure_api_management_api	EXEC	apiId, resourceGroupName, serviceName, subscriptionId	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.

SELECT examples

Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.

vw_api_collections

SELECT
id,
name,
apiId,
base_url,
discovered_via,
display_name,
number_of_api_endpoints,
number_of_api_endpoints_with_sensitive_data_exposed,
number_of_external_api_endpoints,
number_of_inactive_api_endpoints,
number_of_unauthenticated_api_endpoints,
provisioning_state,
resourceGroupName,
sensitivity_label,
serviceName,
subscriptionId,
type
FROM azure.security.vw_api_collections
WHERE subscriptionId = '{{ subscriptionId }}';

api_collections

SELECT
id,
name,
properties,
type
FROM azure.security.api_collections
WHERE subscriptionId = '{{ subscriptionId }}';