@pulumi/azure-native/security/getAPICollection.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
/**
 * Gets an Azure API Management API if it has been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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.
 *
 * Uses Azure REST API version 2022-11-20-preview.
 */
export declare function getAPICollection(args: GetAPICollectionArgs, opts?: pulumi.InvokeOptions): Promise<GetAPICollectionResult>;
export interface GetAPICollectionArgs {
    /**
     * A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
     */
    apiCollectionId: string;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
    /**
     * The name of the API Management service.
     */
    serviceName: string;
}
/**
 * An API collection as represented by Defender for APIs.
 */
export interface GetAPICollectionResult {
    /**
     * Additional data regarding the API collection.
     */
    readonly additionalData?: {
        [key: string]: string;
    };
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * The display name of the Azure API Management API.
     */
    readonly displayName?: string;
    /**
     * Resource Id
     */
    readonly id: string;
    /**
     * Resource name
     */
    readonly name: string;
    /**
     * Resource type
     */
    readonly type: string;
}
/**
 * Gets an Azure API Management API if it has been onboarded to Defender for APIs. If an Azure API Management API is onboarded to 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.
 *
 * Uses Azure REST API version 2022-11-20-preview.
 */
export declare function getAPICollectionOutput(args: GetAPICollectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAPICollectionResult>;
export interface GetAPICollectionOutputArgs {
    /**
     * A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
     */
    apiCollectionId: pulumi.Input<string>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * The name of the API Management service.
     */
    serviceName: pulumi.Input<string>;
}