ApiCollectionProperties interface

Package:

@azure/arm-security

Describes the properties of an API collection.

Properties

baseUrl	The base URI for this API collection. All endpoints of this API collection extend this base URI.
discoveredVia	The resource Id of the resource from where this API collection was discovered.
displayName	The display name of the API collection.
numberOfApiEndpoints	The number of API endpoints discovered in this API collection.
numberOfApiEndpointsWithSensitiveDataExposed	The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
numberOfExternalApiEndpoints	The number of API endpoints in this API collection for which API traffic from the internet was observed.
numberOfInactiveApiEndpoints	The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
numberOfUnauthenticatedApiEndpoints	The number of API endpoints in this API collection that are unauthenticated.
provisioningState	Gets the provisioning state of the API collection.
sensitivityLabel	The highest priority sensitivity label from Microsoft Purview in this API collection.

Property Details

baseUrl

The base URI for this API collection. All endpoints of this API collection extend this base URI.

baseUrl?: string

Property Value

string

discoveredVia

The resource Id of the resource from where this API collection was discovered.

discoveredVia?: string

Property Value

string

displayName

The display name of the API collection.

displayName?: string

Property Value

string

numberOfApiEndpoints

The number of API endpoints discovered in this API collection.

numberOfApiEndpoints?: number

Property Value

number

numberOfApiEndpointsWithSensitiveDataExposed

The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.

numberOfApiEndpointsWithSensitiveDataExposed?: number

Property Value

number

numberOfExternalApiEndpoints

The number of API endpoints in this API collection for which API traffic from the internet was observed.

numberOfExternalApiEndpoints?: number

Property Value

number

numberOfInactiveApiEndpoints

The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.

numberOfInactiveApiEndpoints?: number

Property Value

number

numberOfUnauthenticatedApiEndpoints

The number of API endpoints in this API collection that are unauthenticated.

numberOfUnauthenticatedApiEndpoints?: number

Property Value

number

provisioningState

Gets the provisioning state of the API collection.

provisioningState?: string

Property Value

string

sensitivityLabel

The highest priority sensitivity label from Microsoft Purview in this API collection.

sensitivityLabel?: string

Property Value

string