Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getAPICollectionByAzureApiManagementService
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.security.getAPICollectionByAzureApiManagementService

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
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. 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?: InvokeOptions): 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: 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[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 CompletableFuture<GetAPICollectionByAzureApiManagementServiceResult> getAPICollectionByAzureApiManagementService(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOptions options)
public static Output<GetAPICollectionByAzureApiManagementServiceResult> getAPICollectionByAzureApiManagementService(GetAPICollectionByAzureApiManagementServiceArgs args, InvokeOptions options)

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

    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.
    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:

    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
    Resource Id
    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
    Resource Id
    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
    Resource Id
    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
    Resource Id
    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
    Resource Id
    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
    Resource Id
    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

    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native