Share via

ApiCollection interface

  • Reference
Package:
@azure/arm-security

An API collection as represented by Microsoft Defender for APIs.

Extends
Resource

Properties

baseUrl

The base URI for this API collection. All endpoints of this API collection extend this base URI. NOTE: This property will not be serialized. It can only be populated by the server.
discoveredVia

The resource Id of the resource from where this API collection was discovered. NOTE: This property will not be serialized. It can only be populated by the server.
displayName

The display name of the API collection. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfApiEndpoints

The number of API endpoints discovered in this API collection. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfApiEndpointsWithSensitiveDataExposed

The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfExternalApiEndpoints

The number of API endpoints in this API collection for which API traffic from the internet was observed. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfInactiveApiEndpoints

The number of API endpoints in this API collection that have not received any API traffic in the last 30 days. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfUnauthenticatedApiEndpoints

The number of API endpoints in this API collection that are unauthenticated. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Gets the provisioning state of the API collection. NOTE: This property will not be serialized. It can only be populated by the server.
sensitivityLabel

The highest priority sensitivity label from Microsoft Purview in this API collection. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

baseUrl

The base URI for this API collection. All endpoints of this API collection extend this base URI. NOTE: This property will not be serialized. It can only be populated by the server.

baseUrl?: string

Property Value

string

discoveredVia

The resource Id of the resource from where this API collection was discovered. NOTE: This property will not be serialized. It can only be populated by the server.

discoveredVia?: string

Property Value

string

displayName

The display name of the API collection. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

numberOfApiEndpoints

The number of API endpoints discovered in this API collection. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfApiEndpointsWithSensitiveDataExposed?: number

Property Value

number

numberOfExternalApiEndpoints

The number of API endpoints in this API collection for which API traffic from the internet was observed. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfInactiveApiEndpoints?: number

Property Value

number

numberOfUnauthenticatedApiEndpoints

The number of API endpoints in this API collection that are unauthenticated. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfUnauthenticatedApiEndpoints?: number

Property Value

number

provisioningState

Gets the provisioning state of the API collection. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sensitivityLabel

The highest priority sensitivity label from Microsoft Purview in this API collection. NOTE: This property will not be serialized. It can only be populated by the server.

sensitivityLabel?: string

Property Value

string

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type