Docs
Packagesazure-native.security.getAPICollection
Explore with Pulumi AI
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. 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:security:getAPICollection
arguments:
# arguments dictionaryThe following arguments are supported:
- Api
Collection stringId A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Service
Name string The name of the API Management service.
- Api
Collection stringId A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Service
Name string The name of the API Management service.
- api
Collection StringId A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- service
Name String The name of the API Management service.
- api
Collection stringId A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- service
Name string The name of the API Management service.
- api_
collection_ strid A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- service_
name str The name of the API Management service.
- api
Collection StringId A string representing the apiCollections resource within the Microsoft.Security provider namespace. This string matches the Azure API Management API name.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- service
Name String The name of the API Management service.
getAPICollection Result
The following output properties are available:
- Id string
Resource Id
- Name string
Resource name
- Type string
Resource type
- Additional
Data Dictionary<string, string> Additional data regarding the API collection.
- Display
Name string The display name of the Azure API Management API.
- Id string
Resource Id
- Name string
Resource name
- Type string
Resource type
- Additional
Data map[string]string Additional data regarding the API collection.
- Display
Name string The display name of the Azure API Management API.
- id String
Resource Id
- name String
Resource name
- type String
Resource type
- additional
Data Map<String,String> Additional data regarding the API collection.
- display
Name String The display name of the Azure API Management API.
- id string
Resource Id
- name string
Resource name
- type string
Resource type
- additional
Data {[key: string]: string} Additional data regarding the API collection.
- display
Name string The display name of the Azure API Management API.
- 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.
- id String
Resource Id
- name String
Resource name
- type String
Resource type
- additional
Data Map<String> Additional data regarding the API collection.
- display
Name String The display name of the Azure API Management API.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0