ApiCollection Class

Definition

An API collection as represented by Microsoft Defender for APIs.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Security.Models.ApiCollectionTypeConverter))]
public class ApiCollection : Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IApiCollection, Microsoft.Azure.PowerShell.Cmdlets.Security.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Security.Models.ApiCollectionTypeConverter))>]
type ApiCollection = class
    interface IApiCollection
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class ApiCollection
Implements IApiCollection, IValidates
Inheritance
ApiCollection
Attributes
Implements

Constructors

ApiCollection()

Creates an new ApiCollection instance.

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.

Id

Resource Id

Name

Resource name

NumberOfApiEndpoint

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.

NumberOfExternalApiEndpoint

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

NumberOfInactiveApiEndpoint

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

NumberOfUnauthenticatedApiEndpoint

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

ProvisioningState

Gets the provisioning state of the API collection.

ResourceGroupName

Gets the resource group name

SensitivityLabel

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

Type

Resource type

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ApiCollection.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ApiCollection.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Security.Models.IApiCollection.

FromJsonString(String)

Creates a new instance of ApiCollection, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ApiCollection into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to