Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. security
  6. getAPICollectionByAzureApiManagementService
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.security.getAPICollectionByAzureApiManagementService

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.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft 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 2023-11-15.

    Using getAPICollectionByAzureApiManagementService

    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 getAPICollectionByAzureApiManagementService(args: GetAPICollectionByAzureApiManagementServiceArgs, opts?: InvokeOptions): Promise<GetAPICollectionByAzureApiManagementServiceResult>
function getAPICollectionByAzureApiManagementServiceOutput(args: GetAPICollectionByAzureApiManagementServiceOutputArgs, opts?: InvokeOutputOptions): Output<GetAPICollectionByAzureApiManagementServiceResult>
    def get_api_collection_by_azure_api_management_service(api_id: Optional[str] = None,
                                                       resource_group_name: Optional[str] = None,
                                                       service_name: Optional[str] = None,
                                                       opts: Optional[InvokeOptions] = None) -> GetAPICollectionByAzureApiManagementServiceResult
def get_api_collection_by_azure_api_management_service_output(api_id: pulumi.Input[Optional[str]] = None,
                                                       resource_group_name: pulumi.Input[Optional[str]] = None,
                                                       service_name: pulumi.Input[Optional[str]] = None,
                                                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetAPICollectionByAzureApiManagementServiceResult]
    func LookupAPICollectionByAzureApiManagementService(ctx *Context, args *LookupAPICollectionByAzureApiManagementServiceArgs, opts ...InvokeOption) (*LookupAPICollectionByAzureApiManagementServiceResult, error)
func LookupAPICollectionByAzureApiManagementServiceOutput(ctx *Context, args *LookupAPICollectionByAzureApiManagementServiceOutputArgs, opts ...InvokeOption) LookupAPICollectionByAzureApiManagementServiceResultOutput

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

    public static class GetAPICollectionByAzureApiManagementService 
{
    public static Task<GetAPICollectionByAzureApiManagementServiceResult> InvokeAsync(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetAPICollectionByAzureApiManagementServiceResult> Invoke(GetAPICollectionByAzureApiManagementServiceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAPICollectionByAzureApiManagementServiceResult> Invoke(GetAPICollectionByAzureApiManagementServiceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAPICollectionByAzureApiManagementServiceResult> getAPICollectionByAzureApiManagementService(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOptions options)
public static Output<GetAPICollectionByAzureApiManagementServiceResult> getAPICollectionByAzureApiManagementService(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOptions options)
public static Output<GetAPICollectionByAzureApiManagementServiceResult> getAPICollectionByAzureApiManagementService(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: azure-native:security:getAPICollectionByAzureApiManagementService
  arguments:
    # arguments dictionary
    data "azure-native_security_get_a_p_i_collection_by_azure_api_management_service" "name" {
    # arguments
}

    The following arguments are supported:

    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.
    api_id 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 string
    The name of the resource group. The name is case insensitive.
    service_name 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.
    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.
    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.
    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.

    getAPICollectionByAzureApiManagementService Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    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.
    SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    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.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version string
    The Azure API version of the resource.
    base_url string
    The base URI for this API collection. All endpoints of this API collection extend this base URI.
    discovered_via string
    The resource Id of the resource from where this API collection was discovered.
    display_name string
    The display name of the API collection.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    number_of_api_endpoints number
    The number of API endpoints discovered in this API collection.
    number_of_api_endpoints_with_sensitive_data_exposed number
    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 number
    The number of API endpoints in this API collection for which API traffic from the internet was observed.
    number_of_inactive_api_endpoints number
    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 number
    The number of API endpoints in this API collection that are unauthenticated.
    provisioning_state string
    Gets the provisioning state of the API collection.
    sensitivity_label string
    The highest priority sensitivity label from Microsoft Purview in this API collection.
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    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.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    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.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    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.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    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.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.
    Viewing docs for Azure Native v3.26.0
    published on Thursday, Aug 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial