1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. APICollectionByAzureApiManagementService
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.security.APICollectionByAzureApiManagementService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    An API collection as represented by Microsoft Defender for APIs. Azure REST 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 (
    	"github.com/pulumi/pulumi-azure-native-sdk/security/v2"
    	"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 pulumi
    import pulumi_azure_native as azure_native
    
    api_collection_by_azure_api_management_service = azure_native.security.APICollectionByAzureApiManagementService("apiCollectionByAzureApiManagementService",
        api_id="echo-api",
        resource_group_name="rg1",
        service_name="apimService1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const apiCollectionByAzureApiManagementService = new azure_native.security.APICollectionByAzureApiManagementService("apiCollectionByAzureApiManagementService", {
        apiId: "echo-api",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
    });
    
    resources:
      apiCollectionByAzureApiManagementService:
        type: azure-native:security:APICollectionByAzureApiManagementService
        properties:
          apiId: echo-api
          resourceGroupName: rg1
          serviceName: apimService1
    

    Create APICollectionByAzureApiManagementService Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new APICollectionByAzureApiManagementService(name: string, args: APICollectionByAzureApiManagementServiceArgs, opts?: CustomResourceOptions);
    @overload
    def APICollectionByAzureApiManagementService(resource_name: str,
                                                 args: APICollectionByAzureApiManagementServiceArgs,
                                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def APICollectionByAzureApiManagementService(resource_name: str,
                                                 opts: Optional[ResourceOptions] = None,
                                                 resource_group_name: Optional[str] = None,
                                                 service_name: Optional[str] = None,
                                                 api_id: Optional[str] = None)
    func NewAPICollectionByAzureApiManagementService(ctx *Context, name string, args APICollectionByAzureApiManagementServiceArgs, opts ...ResourceOption) (*APICollectionByAzureApiManagementService, error)
    public APICollectionByAzureApiManagementService(string name, APICollectionByAzureApiManagementServiceArgs args, CustomResourceOptions? opts = null)
    public APICollectionByAzureApiManagementService(String name, APICollectionByAzureApiManagementServiceArgs args)
    public APICollectionByAzureApiManagementService(String name, APICollectionByAzureApiManagementServiceArgs args, CustomResourceOptions options)
    
    type: azure-native:security:APICollectionByAzureApiManagementService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args APICollectionByAzureApiManagementServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args APICollectionByAzureApiManagementServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args APICollectionByAzureApiManagementServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args APICollectionByAzureApiManagementServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args APICollectionByAzureApiManagementServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var apicollectionByAzureApiManagementServiceResource = new AzureNative.Security.APICollectionByAzureApiManagementService("apicollectionByAzureApiManagementServiceResource", new()
    {
        ResourceGroupName = "string",
        ServiceName = "string",
        ApiId = "string",
    });
    
    example, err := security.NewAPICollectionByAzureApiManagementService(ctx, "apicollectionByAzureApiManagementServiceResource", &security.APICollectionByAzureApiManagementServiceArgs{
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    ApiId: pulumi.String("string"),
    })
    
    var apicollectionByAzureApiManagementServiceResource = new APICollectionByAzureApiManagementService("apicollectionByAzureApiManagementServiceResource", APICollectionByAzureApiManagementServiceArgs.builder()        
        .resourceGroupName("string")
        .serviceName("string")
        .apiId("string")
        .build());
    
    apicollection_by_azure_api_management_service_resource = azure_native.security.APICollectionByAzureApiManagementService("apicollectionByAzureApiManagementServiceResource",
        resource_group_name="string",
        service_name="string",
        api_id="string")
    
    const apicollectionByAzureApiManagementServiceResource = new azure_native.security.APICollectionByAzureApiManagementService("apicollectionByAzureApiManagementServiceResource", {
        resourceGroupName: "string",
        serviceName: "string",
        apiId: "string",
    });
    
    type: azure-native:security:APICollectionByAzureApiManagementService
    properties:
        apiId: string
        resourceGroupName: string
        serviceName: string
    

    APICollectionByAzureApiManagementService Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The APICollectionByAzureApiManagementService resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiId String
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    apiId string
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    api_id str
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiId String
    API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the APICollectionByAzureApiManagementService resource produces the following output properties:

    BaseUrl string
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    DiscoveredVia string
    The resource Id of the resource from where this API collection was discovered.
    DisplayName string
    The display name of the API collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    NumberOfApiEndpoints double
    The number of API endpoints discovered in this API collection.
    NumberOfApiEndpointsWithSensitiveDataExposed double
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    NumberOfExternalApiEndpoints double
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    NumberOfInactiveApiEndpoints double
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    NumberOfUnauthenticatedApiEndpoints double
    The number of API endpoints in this API collection that are unauthenticated.
    ProvisioningState string
    Gets the provisioning state of the API collection.
    SensitivityLabel string
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    Type string
    Resource type
    BaseUrl string
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    DiscoveredVia string
    The resource Id of the resource from where this API collection was discovered.
    DisplayName string
    The display name of the API collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    NumberOfApiEndpoints float64
    The number of API endpoints discovered in this API collection.
    NumberOfApiEndpointsWithSensitiveDataExposed float64
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    NumberOfExternalApiEndpoints float64
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    NumberOfInactiveApiEndpoints float64
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    NumberOfUnauthenticatedApiEndpoints float64
    The number of API endpoints in this API collection that are unauthenticated.
    ProvisioningState string
    Gets the provisioning state of the API collection.
    SensitivityLabel string
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    Type string
    Resource type
    baseUrl String
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    discoveredVia String
    The resource Id of the resource from where this API collection was discovered.
    displayName String
    The display name of the API collection.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    numberOfApiEndpoints Double
    The number of API endpoints discovered in this API collection.
    numberOfApiEndpointsWithSensitiveDataExposed Double
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    numberOfExternalApiEndpoints Double
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    numberOfInactiveApiEndpoints Double
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    numberOfUnauthenticatedApiEndpoints Double
    The number of API endpoints in this API collection that are unauthenticated.
    provisioningState String
    Gets the provisioning state of the API collection.
    sensitivityLabel String
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    type String
    Resource type
    baseUrl string
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    discoveredVia string
    The resource Id of the resource from where this API collection was discovered.
    displayName string
    The display name of the API collection.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    numberOfApiEndpoints number
    The number of API endpoints discovered in this API collection.
    numberOfApiEndpointsWithSensitiveDataExposed number
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    numberOfExternalApiEndpoints number
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    numberOfInactiveApiEndpoints number
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    numberOfUnauthenticatedApiEndpoints number
    The number of API endpoints in this API collection that are unauthenticated.
    provisioningState string
    Gets the provisioning state of the API collection.
    sensitivityLabel string
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    type string
    Resource type
    base_url str
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    discovered_via str
    The resource Id of the resource from where this API collection was discovered.
    display_name str
    The display name of the API collection.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    number_of_api_endpoints float
    The number of API endpoints discovered in this API collection.
    number_of_api_endpoints_with_sensitive_data_exposed float
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    number_of_external_api_endpoints float
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    number_of_inactive_api_endpoints float
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    number_of_unauthenticated_api_endpoints float
    The number of API endpoints in this API collection that are unauthenticated.
    provisioning_state str
    Gets the provisioning state of the API collection.
    sensitivity_label str
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    type str
    Resource type
    baseUrl String
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    discoveredVia String
    The resource Id of the resource from where this API collection was discovered.
    displayName String
    The display name of the API collection.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    numberOfApiEndpoints Number
    The number of API endpoints discovered in this API collection.
    numberOfApiEndpointsWithSensitiveDataExposed Number
    The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
    numberOfExternalApiEndpoints Number
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    numberOfInactiveApiEndpoints Number
    The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
    numberOfUnauthenticatedApiEndpoints Number
    The number of API endpoints in this API collection that are unauthenticated.
    provisioningState String
    Gets the provisioning state of the API collection.
    sensitivityLabel String
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    type String
    Resource type

    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} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi