ApiCollectionProperties interface
Describes the properties of an API collection.
Properties
| base |
The base URI for this API collection. All endpoints of this API collection extend this base URI. |
| discovered |
The resource Id of the resource from where this API collection was discovered. |
| display |
The display name of the API collection. |
| number |
The number of API endpoints discovered in this API collection. |
| number |
The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses. |
| number |
The number of API endpoints in this API collection for which API traffic from the internet was observed. |
| number |
The number of API endpoints in this API collection that have not received any API traffic in the last 30 days. |
| number |
The number of API endpoints in this API collection that are unauthenticated. |
| provisioning |
Gets the provisioning state of the API collection. |
| sensitivity |
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?: stringProperty Value
string
discoveredVia
The resource Id of the resource from where this API collection was discovered.
discoveredVia?: stringProperty Value
string
displayName
The display name of the API collection.
displayName?: stringProperty Value
string
numberOfApiEndpoints
The number of API endpoints discovered in this API collection.
numberOfApiEndpoints?: numberProperty Value
number
numberOfApiEndpointsWithSensitiveDataExposed
The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
numberOfApiEndpointsWithSensitiveDataExposed?: numberProperty Value
number
numberOfExternalApiEndpoints
The number of API endpoints in this API collection for which API traffic from the internet was observed.
numberOfExternalApiEndpoints?: numberProperty 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?: numberProperty Value
number
numberOfUnauthenticatedApiEndpoints
The number of API endpoints in this API collection that are unauthenticated.
numberOfUnauthenticatedApiEndpoints?: numberProperty Value
number
provisioningState
Gets the provisioning state of the API collection.
provisioningState?: stringProperty Value
string
sensitivityLabel
The highest priority sensitivity label from Microsoft Purview in this API collection.
sensitivityLabel?: stringProperty Value
string
