API Collections - List By Subscription

Ссылка

Служба:: Defender for Cloud

Версия API:: 2023-11-15

Возвращает список коллекций API в подписке, которая была подключена к Microsoft Defender для API.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	ApiCollectionList	Это означает успешный ответ. Ответ содержит список коллекций API.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Образец запроса

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


/**
 * Samples for ApiCollections List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/
     * APICollections_ListBySubscription_example.json
     */
    /**
     * Sample code: Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender
     * for APIs.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getsAListOfAPICollectionsWithinASubscriptionThatHaveBeenOnboardedToMicrosoftDefenderForAPIs(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.apiCollections().list(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

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_ListBySubscription_example.json
func ExampleAPICollectionsClient_NewListBySubscriptionPager() {
	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().NewListBySubscriptionPager(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

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

/**
 * This sample demonstrates how to Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
 *
 * @summary Gets a list of API collections within a subscription that have been onboarded to Microsoft Defender for APIs.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2023-11-15/examples/ApiCollections/APICollections_ListBySubscription_example.json
 */
async function getsAListOfApiCollectionsWithinASubscriptionThatHaveBeenOnboardedToMicrosoftDefenderForApIs() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "3fa85f64-5717-4562-b3fc-2c963f66afa6";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.aPICollections.listBySubscription()) {
    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

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_ListBySubscription_example.json
// this example is just showing the usage of "APICollections_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (SecurityCenterApiCollectionResource item in subscriptionResource.GetSecurityCenterApiCollectionsAsync())
{
    // 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

Пример ответа

Код состояния:: 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/providers/Microsoft.Security/apiCollections?api-version=2023-11-15&$skipToken=ac943fd6a934"
}

Определения

Имя	Описание
ApiCollection	Коллекция API, представленная Microsoft Defender для API.
ApiCollectionList	Страница списка коллекций API, представленных Microsoft Defender для API.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ProvisioningState	Возвращает состояние подготовки коллекции API.

ApiCollection

Коллекция API, представленная Microsoft Defender для API.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.baseUrl	string	Базовый универсальный код ресурса (URI) для этой коллекции API. Все конечные точки этой коллекции API расширяют базовый универсальный код ресурса (URI).
properties.discoveredVia	string	Идентификатор ресурса ресурса, из которого обнаружена эта коллекция API.
properties.displayName	string	Отображаемое имя коллекции API.
properties.numberOfApiEndpoints	integer	Количество конечных точек API, обнаруженных в этой коллекции API.
properties.numberOfApiEndpointsWithSensitiveDataExposed	integer	Количество конечных точек API в этой коллекции API, которые предоставляют конфиденциальные данные в своих запросах и /или ответах.
properties.numberOfExternalApiEndpoints	integer	Количество конечных точек API в этой коллекции API, для которых наблюдался трафик API из Интернета.
properties.numberOfInactiveApiEndpoints	integer	Количество конечных точек API в этой коллекции API, которые не получили никакого трафика API за последние 30 дней.
properties.numberOfUnauthenticatedApiEndpoints	integer	Количество конечных точек API в этой коллекции API, не прошедших проверку подлинности.
properties.provisioningState	ProvisioningState	Возвращает состояние подготовки коллекции API.
properties.sensitivityLabel	string	Метка конфиденциальности с наивысшим приоритетом из Microsoft Purview в этой коллекции API.
type	string	Тип ресурса

ApiCollectionList

Страница списка коллекций API, представленных Microsoft Defender для API.

Имя	Тип	Описание
nextLink	string	URI для получения следующей страницы.
value	ApiCollection[]	Коллекции API на этой странице.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ProvisioningState

Возвращает состояние подготовки коллекции API.

Имя	Тип	Описание
Canceled	string
Failed	string
InProgress	string
Succeeded	string

Поделиться через

API Collections - List By Subscription

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

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

Образец запроса

Пример ответа

Определения

ApiCollection

ApiCollectionList

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

Дополнительные ресурсы