APICollectionByAzureApiManagementService

class APICollectionByAzureApiManagementService : KotlinCustomResource

An API collection as represented by Microsoft Defender for APIs. Uses Azure REST API version 2023-11-15. In version 2.x of the Azure Native provider, it used API version 2023-11-15.

Example Usage

Onboard an Azure API Management API to Microsoft Defender for APIs

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiCollectionByAzureApiManagementService = new AzureNative.Security.APICollectionByAzureApiManagementService("apiCollectionByAzureApiManagementService", new()
{
ApiId = "echo-api",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});
package main
import (
security "github.com/pulumi/pulumi-azure-native-sdk/security/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := security.NewAPICollectionByAzureApiManagementService(ctx, "apiCollectionByAzureApiManagementService", &security.APICollectionByAzureApiManagementServiceArgs{
ApiId: pulumi.String("echo-api"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.security.APICollectionByAzureApiManagementService;
import com.pulumi.azurenative.security.APICollectionByAzureApiManagementServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apiCollectionByAzureApiManagementService = new APICollectionByAzureApiManagementService("apiCollectionByAzureApiManagementService", APICollectionByAzureApiManagementServiceArgs.builder()
.apiId("echo-api")
.resourceGroupName("rg1")
.serviceName("apimService1")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:security:APICollectionByAzureApiManagementService echo-api /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/providers/Microsoft.Security/apiCollections/{apiId}

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val baseUrl: Output<String>

The base URI for this API collection. All endpoints of this API collection extend this base URI.

Link copied to clipboard
val discoveredVia: Output<String>

The resource Id of the resource from where this API collection was discovered.

Link copied to clipboard
val displayName: Output<String>

The display name of the API collection.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Resource name

Link copied to clipboard

The number of API endpoints discovered in this API collection.

The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.

Link copied to clipboard

The number of API endpoints in this API collection for which API traffic from the internet was observed.

Link copied to clipboard

The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.

Link copied to clipboard

The number of API endpoints in this API collection that are unauthenticated.

Link copied to clipboard

Gets the provisioning state of the API collection.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The highest priority sensitivity label from Microsoft Purview in this API collection.

Link copied to clipboard
val type: Output<String>

Resource type

Link copied to clipboard
val urn: Output<String>