API Collections - Onboard Azure Api Management Api

Serviço:

Defender for Cloud

Versão da API:

2023-11-15

Integrar uma API de Gerenciamento de API do Azure ao Microsoft Defender para APIs. O sistema começará a monitorar as operações dentro da API de Gerenciamento do Azure para comportamentos intrusivos e fornecerá alertas para ataques detectados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiId	path	True	string	Identificador de revisão de API. Deve ser exclusivo na instância do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão. Padrão Regex: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço de Gerenciamento de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApiCollection	Isso indica uma resposta bem-sucedida para a operação de criação ou atualização. A resposta contém as propriedades da coleção de API.
201 Created	ApiCollection	Isso indica uma resposta bem-sucedida para a operação de criação ou atualização. A resposta contém as propriedades da coleção de API. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Onboard an Azure API Management API to Microsoft Defender for APIs

Solicitação de exemplo

HTTP

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

Java

/**
 * Samples for ApiCollections OnboardAzureApiManagementApi.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/
     * APICollections_OnboardAzureApiManagementApi_example.json
     */
    /**
     * Sample code: Onboard an Azure API Management API to Microsoft Defender for APIs.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void onboardAnAzureAPIManagementAPIToMicrosoftDefenderForAPIs(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.apiCollections().onboardAzureApiManagementApi("rg1", "apimService1", "echo-api",
            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_OnboardAzureApiManagementApi_example.json
func ExampleAPICollectionsClient_BeginOnboardAzureAPIManagementAPI() {
	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)
	}
	poller, err := clientFactory.NewAPICollectionsClient().BeginOnboardAzureAPIManagementAPI(ctx, "rg1", "apimService1", "echo-api", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APICollection = 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 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/APICollections_OnboardAzureApiManagementApi_example.json
 */
async function onboardAnAzureApiManagementApiToMicrosoftDefenderForApIs() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "3fa85f64-5717-4562-b3fc-2c963f66afa6";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.aPICollections.beginOnboardAzureApiManagementApiAndWait(
    resourceGroupName,
    serviceName,
    apiId,
  );
  console.log(result);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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_OnboardAzureApiManagementApi_example.json
// this example is just showing the usage of "APICollections_OnboardAzureApiManagementApi" 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 SecurityCenterApiCollectionResource created on azure
// for more information of creating SecurityCenterApiCollectionResource, please refer to the document of SecurityCenterApiCollectionResource
string subscriptionId = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "echo-api";
ResourceIdentifier securityCenterApiCollectionResourceId = SecurityCenterApiCollectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
SecurityCenterApiCollectionResource securityCenterApiCollection = client.GetSecurityCenterApiCollectionResource(securityCenterApiCollectionResourceId);

// invoke the operation
ArmOperation<SecurityCenterApiCollectionResource> lro = await securityCenterApiCollection.UpdateAsync(WaitUntil.Completed);
SecurityCenterApiCollectionResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:

200

{
  "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"
  }
}

Código de status:

201

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

{
  "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": "InProgress"
  }
}

Definições

Nome	Description
ApiCollection	Uma coleção de API representada pelo Microsoft Defender para APIs.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProvisioningState	Obtém o estado de provisionamento da coleção de API.

ApiCollection

Uma coleção de API representada pelo Microsoft Defender para APIs.

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.baseUrl	string	O URI base para essa coleção de API. Todos os pontos de extremidade dessa coleção de API estendem esse URI base.
properties.discoveredVia	string	A ID do recurso de onde essa coleção de API foi descoberta.
properties.displayName	string	O nome de exibição da coleção de API.
properties.numberOfApiEndpoints	integer	O número de pontos de extremidade de API descobertos nesta coleção de API.
properties.numberOfApiEndpointsWithSensitiveDataExposed	integer	O número de pontos de extremidade de API nesta coleção de API que estão expondo dados confidenciais em suas solicitações e/ou respostas.
properties.numberOfExternalApiEndpoints	integer	O número de pontos de extremidade de API nesta coleção de API para a qual o tráfego de API da Internet foi observado.
properties.numberOfInactiveApiEndpoints	integer	O número de pontos de extremidade de API nesta coleção de API que não receberam nenhum tráfego de API nos últimos 30 dias.
properties.numberOfUnauthenticatedApiEndpoints	integer	O número de pontos de extremidade de API nesta coleção de API que não são autenticados.
properties.provisioningState	ProvisioningState	Obtém o estado de provisionamento da coleção de API.
properties.sensitivityLabel	string	O rótulo de confidencialidade de prioridade mais alta do Microsoft Purview nesta coleção de API.
type	string	Tipo de recurso

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

Obtém o estado de provisionamento da coleção de API.

Nome	Tipo	Description
Canceled	string
Failed	string
InProgress	string
Succeeded	string