Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getAPICollection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.security.getAPICollection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    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.

    Using getAPICollection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAPICollection(args: GetAPICollectionArgs, opts?: InvokeOptions): Promise<GetAPICollectionResult>
function getAPICollectionOutput(args: GetAPICollectionOutputArgs, opts?: InvokeOptions): Output<GetAPICollectionResult>
    def get_api_collection(api_collection_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAPICollectionResult
def get_api_collection_output(api_collection_id: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       service_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAPICollectionResult]
    func LookupAPICollection(ctx *Context, args *LookupAPICollectionArgs, opts ...InvokeOption) (*LookupAPICollectionResult, error)
func LookupAPICollectionOutput(ctx *Context, args *LookupAPICollectionOutputArgs, opts ...InvokeOption) LookupAPICollectionResultOutput

    > Note: This function is named LookupAPICollection in the Go SDK.

    public static class GetAPICollection 
{
    public static Task<GetAPICollectionResult> InvokeAsync(GetAPICollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetAPICollectionResult> Invoke(GetAPICollectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAPICollectionResult> getAPICollection(GetAPICollectionArgs args, InvokeOptions options)
public static Output<GetAPICollectionResult> getAPICollection(GetAPICollectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:security:getAPICollection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiCollectionId string
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiCollectionId string
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    apiCollectionId String
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiCollectionId string
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    api_collection_id str
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    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.
    apiCollectionId String
    A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.

    getAPICollection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource Id
    Name string
    Resource name
    Type string
    Resource type
    AdditionalData Dictionary<string, string>
    Additional data regarding the API collection.
    DisplayName string
    The display name of the Azure API Management API.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource Id
    Name string
    Resource name
    Type string
    Resource type
    AdditionalData map[string]string
    Additional data regarding the API collection.
    DisplayName string
    The display name of the Azure API Management API.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource Id
    name String
    Resource name
    type String
    Resource type
    additionalData Map<String,String>
    Additional data regarding the API collection.
    displayName String
    The display name of the Azure API Management API.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource Id
    name string
    Resource name
    type string
    Resource type
    additionalData {[key: string]: string}
    Additional data regarding the API collection.
    displayName string
    The display name of the Azure API Management API.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource Id
    name str
    Resource name
    type str
    Resource type
    additional_data Mapping[str, str]
    Additional data regarding the API collection.
    display_name str
    The display name of the Azure API Management API.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource Id
    name String
    Resource name
    type String
    Resource type
    additionalData Map<String>
    Additional data regarding the API collection.
    displayName String
    The display name of the Azure API Management API.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native