ApiCollectionInner Class

Package:

com.azure.resourcemanager.security.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-security:1.1.0-beta.1

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.security.fluent.models.ApiCollectionInner

public final class ApiCollectionInner
extends ProxyResource

An API collection as represented by Microsoft Defender for APIs.

Method Summary

Modifier and Type	Method and Description
String	baseUrl() Get the baseUrl property: The base URI for this API collection.
String	discoveredVia() Get the discoveredVia property: The resource Id of the resource from where this API collection was discovered.
String	displayName() Get the displayName property: The display name of the API collection.
static ApiCollectionInner	fromJson(JsonReader jsonReader) Reads an instance of ApiCollectionInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	name() Get the name property: The name of the resource.
Long	numberOfApiEndpoints() Get the numberOfApiEndpoints property: The number of API endpoints discovered in this API collection.
Long	numberOfApiEndpointsWithSensitiveDataExposed() Get the numberOfApiEndpointsWithSensitiveDataExposed property: The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
Long	numberOfExternalApiEndpoints() Get the numberOfExternalApiEndpoints property: The number of API endpoints in this API collection for which API traffic from the internet was observed.
Long	numberOfInactiveApiEndpoints() Get the numberOfInactiveApiEndpoints property: The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
Long	numberOfUnauthenticatedApiEndpoints() Get the numberOfUnauthenticatedApiEndpoints property: The number of API endpoints in this API collection that are unauthenticated.
ProvisioningState	provisioningState() Get the provisioningState property: Gets the provisioning state of the API collection.
String	sensitivityLabel() Get the sensitivityLabel property: The highest priority sensitivity label from Microsoft Purview in this API collection.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

baseUrl

public String baseUrl()

Get 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 String discoveredVia()

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

Returns:

the discoveredVia value.

displayName

public String displayName()

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

Returns:

the displayName value.

fromJson

public static ApiCollectionInner fromJson(JsonReader jsonReader)

Reads an instance of ApiCollectionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApiCollectionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

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

Overrides:

ApiCollectionInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ApiCollectionInner.name()

Returns:

the name value.

numberOfApiEndpoints

public Long numberOfApiEndpoints()

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

Returns:

the numberOfApiEndpoints value.

numberOfApiEndpointsWithSensitiveDataExposed

public Long numberOfApiEndpointsWithSensitiveDataExposed()

Get 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 Long numberOfExternalApiEndpoints()

Get 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 Long numberOfInactiveApiEndpoints()

Get 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 Long numberOfUnauthenticatedApiEndpoints()

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

Returns:

the numberOfUnauthenticatedApiEndpoints value.

provisioningState

public ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

sensitivityLabel

public String sensitivityLabel()

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

Returns:

the sensitivityLabel value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ApiCollectionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

ApiCollectionInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.