API Collections - List By Azure Api Management Service

Servicio:

Defender for Cloud

Versión de la API:

2023-11-15

Obtiene una lista de las API de Azure API Management incorporadas.
Obtiene una lista de las API de Azure API Management que se han incorporado a Microsoft Defender para API. Si se incorpora una API de Azure API Management a Microsoft Defender para API, el sistema supervisará las operaciones dentro de la API de Azure API Management para detectar comportamientos intrusivos y proporcionará alertas de ataques detectados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/providers/Microsoft.Security/apiCollections?api-version=2023-11-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ApiCollectionList	Esto indica una respuesta correcta. La respuesta contiene la lista de colecciones de API.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/providers/Microsoft.Security/apiCollections?api-version=2023-11-15

Java

/**
 * Samples for ApiCollections ListByAzureApiManagementService.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/
     * APICollections_ListByAzureApiManagementService_example.json
     */
    /**
     * Sample code: Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getsAListOfAzureAPIManagementAPIsThatHaveBeenOnboardedToMicrosoftDefenderForAPIs(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.apiCollections().listByAzureApiManagementService("rg1", "apimService1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/APICollections_ListByAzureApiManagementService_example.json
func ExampleAPICollectionsClient_NewListByAzureAPIManagementServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAPICollectionsClient().NewListByAzureAPIManagementServicePager("rg1", "apimService1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APICollectionList = armsecurity.APICollectionList{
		// 	Value: []*armsecurity.APICollection{
		// 		{
		// 			Name: to.Ptr("echo-api"),
		// 			Type: to.Ptr("Microsoft.Security/apiCollections"),
		// 			ID: to.Ptr("/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/providers/Microsoft.Security/apiCollections/echo-api"),
		// 			Properties: &armsecurity.APICollectionProperties{
		// 				BaseURL: to.Ptr("https://apimservice1.azure-api.net/echo"),
		// 				DiscoveredVia: to.Ptr("/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
		// 				DisplayName: to.Ptr("Echo API"),
		// 				NumberOfAPIEndpoints: to.Ptr[int64](6),
		// 				NumberOfAPIEndpointsWithSensitiveDataExposed: to.Ptr[int64](1),
		// 				NumberOfExternalAPIEndpoints: to.Ptr[int64](3),
		// 				NumberOfInactiveAPIEndpoints: to.Ptr[int64](3),
		// 				NumberOfUnauthenticatedAPIEndpoints: to.Ptr[int64](1),
		// 				ProvisioningState: to.Ptr(armsecurity.ProvisioningStateSucceeded),
		// 				SensitivityLabel: to.Ptr("Highly Confidential"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/APICollections_ListByAzureApiManagementService_example.json
 */
async function getsAListOfAzureApiManagementApIsThatHaveBeenOnboardedToMicrosoftDefenderForApis() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "3fa85f64-5717-4562-b3fc-2c963f66afa6";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.aPICollections.listByAzureApiManagementService(
    resourceGroupName,
    serviceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/APICollections_ListByAzureApiManagementService_example.json
// this example is just showing the usage of "APICollections_ListByAzureApiManagementService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SecurityCenterApiCollectionResource
string serviceName = "apimService1";
SecurityCenterApiCollectionCollection collection = resourceGroupResource.GetSecurityCenterApiCollections(serviceName);

// invoke the operation and iterate over the result
await foreach (SecurityCenterApiCollectionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SecurityCenterApiCollectionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/providers/Microsoft.Security/apiCollections/echo-api",
      "name": "echo-api",
      "type": "Microsoft.Security/apiCollections",
      "properties": {
        "provisioningState": "Succeeded",
        "displayName": "Echo API",
        "discoveredVia": "/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
        "baseUrl": "https://apimservice1.azure-api.net/echo",
        "numberOfApiEndpoints": 6,
        "numberOfInactiveApiEndpoints": 3,
        "numberOfUnauthenticatedApiEndpoints": 1,
        "numberOfExternalApiEndpoints": 3,
        "numberOfApiEndpointsWithSensitiveDataExposed": 1,
        "sensitivityLabel": "Highly Confidential"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/providers/Microsoft.Security/apiCollections?api-version=2023-11-15&$skipToken=ac943fd6a934"
}

Definiciones

Nombre	Description
ApiCollection	Colección de API representada por Microsoft Defender para LAS API.
ApiCollectionList	Página de una lista de colecciones de API representadas por Microsoft Defender para LAS API.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Obtiene el estado de aprovisionamiento de la colección de API.

ApiCollection

Object

Colección de API representada por Microsoft Defender para LAS API.

Nombre	Tipo	Description
id	string	Identificador de recurso
name	string	Nombre del recurso
properties.baseUrl	string (uri)	URI base para esta colección de API. Todos los puntos de conexión de esta colección de API amplían este URI base.
properties.discoveredVia	string (arm-id)	Identificador de recurso del recurso desde el que se detectó esta colección de API.
properties.displayName	string	Nombre para mostrar de la colección de API.
properties.numberOfApiEndpoints	integer (int64)	Número de puntos de conexión de API detectados en esta colección de API.
properties.numberOfApiEndpointsWithSensitiveDataExposed	integer (int64)	Número de puntos de conexión de API de esta colección de API que exponen datos confidenciales en sus solicitudes o respuestas.
properties.numberOfExternalApiEndpoints	integer (int64)	Número de puntos de conexión de API de esta colección de API para las que se observó el tráfico de API desde Internet.
properties.numberOfInactiveApiEndpoints	integer (int64)	Número de puntos de conexión de API de esta colección de API que no han recibido ningún tráfico de API en los últimos 30 días.
properties.numberOfUnauthenticatedApiEndpoints	integer (int64)	Número de puntos de conexión de API de esta colección de API que no están autenticados.
properties.provisioningState	ProvisioningState	Obtiene el estado de aprovisionamiento de la colección de API.
properties.sensitivityLabel	string	Etiqueta de confidencialidad de prioridad más alta de Microsoft Purview en esta colección de API.
type	string	Tipo de recurso

ApiCollectionList

Object

Página de una lista de colecciones de API representadas por Microsoft Defender para LAS API.

Nombre	Tipo	Description
nextLink	string	Identificador URI para capturar la página siguiente.
value	ApiCollection[]	Colecciones de API en esta página.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Enumeración

Obtiene el estado de aprovisionamiento de la colección de API.

Valor	Description
Canceled
Failed
InProgress
Succeeded