ApiCollection Interface

public interface ApiCollection

An immutable client-side representation of ApiCollection.

Method Summary

Modifier and Type Method and Description
abstract String baseUrl()

Gets the baseUrl property: The base URI for this API collection.

abstract String discoveredVia()

Gets the discoveredVia property: The resource Id of the resource from where this API collection was discovered.

abstract String displayName()

Gets the displayName property: The display name of the API collection.

abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

abstract ApiCollectionInner innerModel()

Gets the inner com.azure.resourcemanager.security.fluent.models.ApiCollectionInner object.

abstract String name()

Gets the name property: The name of the resource.

abstract Long numberOfApiEndpoints()

Gets the numberOfApiEndpoints property: The number of API endpoints discovered in this API collection.

abstract Long numberOfApiEndpointsWithSensitiveDataExposed()

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

abstract Long numberOfExternalApiEndpoints()

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

abstract Long numberOfInactiveApiEndpoints()

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

abstract Long numberOfUnauthenticatedApiEndpoints()

Gets the numberOfUnauthenticatedApiEndpoints property: The number of API endpoints in this API collection that are unauthenticated.

abstract ProvisioningState provisioningState()

Gets the provisioningState property: Gets the provisioning state of the API collection.

abstract String sensitivityLabel()

Gets the sensitivityLabel property: The highest priority sensitivity label from Microsoft Purview in this API collection.

abstract String type()

Gets the type property: The type of the resource.

Method Details

baseUrl

public abstract String baseUrl()

Gets the baseUrl property: The base URI for this API collection. All endpoints of this API collection extend this base URI.

Returns:

the baseUrl value.

discoveredVia

public abstract String discoveredVia()

Gets the discoveredVia property: The resource Id of the resource from where this API collection was discovered.

Returns:

the discoveredVia value.

displayName

public abstract String displayName()

Gets the displayName property: The display name of the API collection.

Returns:

the displayName value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract ApiCollectionInner innerModel()

Gets the inner com.azure.resourcemanager.security.fluent.models.ApiCollectionInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

numberOfApiEndpoints

public abstract Long numberOfApiEndpoints()

Gets the numberOfApiEndpoints property: The number of API endpoints discovered in this API collection.

Returns:

the numberOfApiEndpoints value.

numberOfApiEndpointsWithSensitiveDataExposed

public abstract Long numberOfApiEndpointsWithSensitiveDataExposed()

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

Returns:

the numberOfApiEndpointsWithSensitiveDataExposed value.

numberOfExternalApiEndpoints

public abstract Long numberOfExternalApiEndpoints()

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

Returns:

the numberOfExternalApiEndpoints value.

numberOfInactiveApiEndpoints

public abstract Long numberOfInactiveApiEndpoints()

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

Returns:

the numberOfInactiveApiEndpoints value.

numberOfUnauthenticatedApiEndpoints

public abstract Long numberOfUnauthenticatedApiEndpoints()

Gets the numberOfUnauthenticatedApiEndpoints property: The number of API endpoints in this API collection that are unauthenticated.

Returns:

the numberOfUnauthenticatedApiEndpoints value.

provisioningState

public abstract ProvisioningState provisioningState()

Gets the provisioningState property: Gets the provisioning state of the API collection.

Returns:

the provisioningState value.

sensitivityLabel

public abstract String sensitivityLabel()

Gets the sensitivityLabel property: The highest priority sensitivity label from Microsoft Purview in this API collection.

Returns:

the sensitivityLabel value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

Applies to