Share via


@azure-rest/defender-easm package

Interfaces

AlexaInfoOutput
AsAssetOutput

A inventory base model created for swagger documentation purpose

AsAssetResourceOutput

The items in the current page of results.

AssetPageResultOutput

The page of assets that match the provided metric.

AssetResourceOutputParent

The items in the current page of results.

AssetSecurityPolicyOutput
AssetSummaryResultOutput

The collection of asset summaries.

AssetUpdateData

A request body used to update an asset.

AttributeOutput
AuditTrailItemOutput

The history of how this asset was pulled into the workspace through the discovery process.

AzureDataExplorerDataConnectionData
AzureDataExplorerDataConnectionOutput
AzureDataExplorerDataConnectionProperties

AzureDataExplorerDataConnectionProperties

AzureDataExplorerDataConnectionPropertiesOutput

The properties required to establish connection to a particular service

BannerOutput
CancelTask
CancelTask200Response

The request has succeeded.

CancelTaskDefaultHeaders
CancelTaskDefaultResponse
ContactAssetOutput

A inventory base model created for swagger documentation purpose

ContactAssetResourceOutput

The items in the current page of results.

CookieOutput
CreateOrReplaceDataConnection200Response

The request has succeeded.

CreateOrReplaceDataConnectionBodyParam
CreateOrReplaceDataConnectionDefaultHeaders
CreateOrReplaceDataConnectionDefaultResponse
CreateOrReplaceDiscoGroup200Response

The request has succeeded.

CreateOrReplaceDiscoGroupBodyParam
CreateOrReplaceDiscoGroupDefaultHeaders
CreateOrReplaceDiscoGroupDefaultResponse
CreateOrReplaceSavedFilter200Response

The request has succeeded.

CreateOrReplaceSavedFilterBodyParam
CreateOrReplaceSavedFilterDefaultHeaders
CreateOrReplaceSavedFilterDefaultResponse
CveOutput
Cvss3SummaryOutput
DataConnectionDataParent
DataConnectionOutputParent
DataConnectionProperties

DataConnectionProperties

DataConnectionPropertiesOutput

The properties required to establish connection to a particular service

DeleteDataConnection204Response

There is no content to send for this request, but the headers may be useful.

DeleteDataConnectionDefaultHeaders
DeleteDataConnectionDefaultResponse
DeleteSavedFilter204Response

There is no content to send for this request, but the headers may be useful.

DeleteSavedFilterDefaultHeaders
DeleteSavedFilterDefaultResponse
DependentResourceOutput
DiscoGroupData

A request body used to create a discovery group.

DiscoGroupOutput
DiscoRunPageResultOutput
DiscoRunResultOutput

The latest run of this disco group with some limited information, null if the group has never been run.

DiscoSource

Source entity used to drive discovery.

DiscoSourceOutput

Source entity used to drive discovery.

DiscoTemplateOutput

The items in the current page of results.

DomainAssetOutput
DomainAssetResourceOutput

The items in the current page of results.

EasmClientOptions

The optional parameters for the client

ErrorDetailOutput

This is the top-level error object whose code matches the x-ms-error-code response header.

GetAssetResource
GetAssetResource200Response

The request has succeeded.

GetAssetResourceDefaultHeaders
GetAssetResourceDefaultResponse
GetBillable
GetBillable200Response

The request has succeeded.

GetBillableDefaultHeaders
GetBillableDefaultResponse
GetDataConnection
GetDataConnection200Response

The request has succeeded.

GetDataConnectionDefaultHeaders
GetDataConnectionDefaultResponse
GetDiscoGroup
GetDiscoGroup200Response

The request has succeeded.

GetDiscoGroupDefaultHeaders
GetDiscoGroupDefaultResponse
GetDiscoTemplate
GetDiscoTemplate200Response

The request has succeeded.

GetDiscoTemplateDefaultHeaders
GetDiscoTemplateDefaultResponse
GetSavedFilter
GetSavedFilter200Response

The request has succeeded.

GetSavedFilterDefaultHeaders
GetSavedFilterDefaultResponse
GetSnapshot
GetSnapshot200Response

The request has succeeded.

GetSnapshotBodyParam
GetSnapshotDefaultHeaders
GetSnapshotDefaultResponse
GetSummary
GetSummary200Response

The request has succeeded.

GetSummaryBodyParam
GetSummaryDefaultHeaders
GetSummaryDefaultResponse
GetTask
GetTask200Response

The request has succeeded.

GetTaskDefaultHeaders
GetTaskDefaultResponse
GuidPairOutput
HostAssetOutput

A inventory base model created for swagger documentation purpose

HostAssetResourceOutput

The items in the current page of results.

HostCoreOutput
InnerErrorOutput

This is an object containing more specific information than the current object about the error.

InventoryAssetOutput

A inventory base model created for swagger documentation purpose

IpAddressAssetOutput

A inventory base model created for swagger documentation purpose

IpAddressAssetResourceOutput

The items in the current page of results.

IpBlockAssetOutput

A inventory base model created for swagger documentation purpose

IpBlockAssetResourceOutput

The items in the current page of results.

IpBlockOutput
ListAssetResource
ListAssetResource200Response

The request has succeeded.

ListAssetResourceDefaultHeaders
ListAssetResourceDefaultResponse
ListAssetResourceQueryParam
ListAssetResourceQueryParamProperties
ListDataConnection
ListDataConnection200Response

The request has succeeded.

ListDataConnectionDefaultHeaders
ListDataConnectionDefaultResponse
ListDataConnectionQueryParam
ListDataConnectionQueryParamProperties
ListDiscoGroup
ListDiscoGroup200Response

The request has succeeded.

ListDiscoGroupDefaultHeaders
ListDiscoGroupDefaultResponse
ListDiscoGroupQueryParam
ListDiscoGroupQueryParamProperties
ListDiscoTemplate
ListDiscoTemplate200Response

The request has succeeded.

ListDiscoTemplateDefaultHeaders
ListDiscoTemplateDefaultResponse
ListDiscoTemplateQueryParam
ListDiscoTemplateQueryParamProperties
ListRuns
ListRuns200Response

The request has succeeded.

ListRunsDefaultHeaders
ListRunsDefaultResponse
ListRunsQueryParam
ListRunsQueryParamProperties
ListSavedFilter
ListSavedFilter200Response

The request has succeeded.

ListSavedFilterDefaultHeaders
ListSavedFilterDefaultResponse
ListSavedFilterQueryParam
ListSavedFilterQueryParamProperties
ListTask
ListTask200Response

The request has succeeded.

ListTaskDefaultHeaders
ListTaskDefaultResponse
ListTaskQueryParam
ListTaskQueryParamProperties
LocationOutput
LogAnalyticsDataConnectionData
LogAnalyticsDataConnectionOutput
LogAnalyticsDataConnectionProperties

LogAnalyticsDataConnectionProperties

LogAnalyticsDataConnectionPropertiesOutput

The properties required to establish connection to a particular service

ObservedBooleanOutput

Template model for observed values

ObservedHeaderOutput

Template model for observed values

ObservedIntegerOutput

Template model for observed values

ObservedIntegersOutput

Template model for observed values

ObservedLocationOutput

Template model for observed values

ObservedLongOutput

Template model for observed values

ObservedPortStateOutput

Template model for observed values

ObservedStringOutput

Template model for observed values

ObservedValueOutput

Template model for observed values

PageAssetOutput

A inventory base model created for swagger documentation purpose

PageAssetResourceOutput

The items in the current page of results.

PageCauseOutput
PageSettings

An interface that tracks the settings for paged iteration

PagedAssetResourceOutput

Paged collection of AssetResource items

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PagedDataConnectionOutput

Paged collection of DataConnection items

PagedDiscoGroupOutput

Paged collection of DiscoGroup items

PagedDiscoTemplateOutput

Paged collection of DiscoTemplate items

PagedSavedFilterOutput

Paged collection of SavedFilter items

PagedTaskOutput

Paged collection of Task items

PagingOptions

Options for the paging helper

PortOutput
ReportAssetSnapshotRequest

A request body used to retrieve an asset report snapshot.

ReportAssetSnapshotResultOutput

A snapshot of assets captured daily for the provided metric. Asset details only contain primary properties. Detailed asset data can be retrieved from the asset endpoints.

ReportAssetSummaryRequest

A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories.

ReportAssetSummaryResultOutput
ReportBillableAssetBreakdownOutput

The breakdown of billable asset counts for each asset type.

ReportBillableAssetSnapshotResultOutput
ReportBillableAssetSummaryResultOutput
ReputationOutput
ResourceUrlOutput
Routes
RunDiscoGroup
RunDiscoGroup204Response

There is no content to send for this request, but the headers may be useful.

RunDiscoGroupDefaultHeaders
RunDiscoGroupDefaultResponse
SavedFilterData

A request body used to create a saved filter.

SavedFilterOutput
ScanMetadataOutput
ServiceOutput
SoaRecordOutput
SourceOutput
SslCertAssetOutput

A inventory base model created for swagger documentation purpose

SslCertAssetResourceOutput

The items in the current page of results.

SslServerConfigOutput
SubResourceIntegrityCheckOutput
TaskOutput
UpdateAssets200Response

The request has succeeded.

UpdateAssetsBodyParam
UpdateAssetsDefaultHeaders
UpdateAssetsDefaultResponse
UpdateAssetsQueryParam
UpdateAssetsQueryParamProperties
ValidateDataConnection
ValidateDataConnection200Response

The request has succeeded.

ValidateDataConnectionBodyParam
ValidateDataConnectionDefaultHeaders
ValidateDataConnectionDefaultResponse
ValidateDiscoGroup
ValidateDiscoGroup200Response

The request has succeeded.

ValidateDiscoGroupBodyParam
ValidateDiscoGroupDefaultHeaders
ValidateDiscoGroupDefaultResponse
ValidateResultOutput

Validate result for validate action endpoints

WebComponentOutput

Type Aliases

AssetResourceOutput

The items in the current page of results.

AssetStateOutput

Alias for AssetStateOutput

AssetUpdateState

Alias for AssetUpdateState

AssetUpdateStateOutput

Alias for AssetUpdateStateOutput

AssetUpdateTransfers

Alias for AssetUpdateTransfers

AuditTrailItemKindOutput

Alias for AuditTrailItemKindOutput

CancelTaskParameters
CreateOrReplaceDataConnectionParameters
CreateOrReplaceDiscoGroupParameters
CreateOrReplaceSavedFilterParameters
DataConnectionContent

Alias for DataConnectionContent

DataConnectionContentOutput

Alias for DataConnectionContentOutput

DataConnectionData
DataConnectionFrequency

Alias for DataConnectionFrequency

DataConnectionFrequencyOutput

Alias for DataConnectionFrequencyOutput

DataConnectionOutput
DeleteDataConnectionParameters
DeleteSavedFilterParameters
DiscoRunStateOutput

Alias for DiscoRunStateOutput

DiscoSourceKind

Alias for DiscoSourceKind

DiscoSourceKindOutput

Alias for DiscoSourceKindOutput

EasmClient
GetArrayType

Helper type to extract the type of an array

GetAssetResourceParameters
GetBillableParameters
GetDataConnectionParameters
GetDiscoGroupParameters
GetDiscoTemplateParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.

GetSavedFilterParameters
GetSnapshotParameters
GetSummaryParameters
GetTaskParameters
ListAssetResourceParameters
ListDataConnectionParameters
ListDiscoGroupParameters
ListDiscoTemplateParameters
ListRunsParameters
ListSavedFilterParameters
ListTaskParameters
ObservedPortStateValueOutput

Alias for ObservedPortStateValueOutput

PageAssetRedirectTypeOutput

Alias for PageAssetRedirectTypeOutput

PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter

ReportBillableAssetBreakdownKindOutput

Alias for ReportBillableAssetBreakdownKindOutput

RunDiscoGroupParameters
SslCertAssetValidationTypeOutput

Alias for SslCertAssetValidationTypeOutput

TaskPhaseOutput

Alias for TaskPhaseOutput

TaskStateOutput

Alias for TaskStateOutput

UpdateAssetsParameters
ValidateDataConnectionParameters
ValidateDiscoGroupParameters

Functions

default(string, TokenCredential, EasmClientOptions)

Initialize a new instance of EasmClient

isUnexpected(ListAssetResource200Response | ListAssetResourceDefaultResponse)
isUnexpected(UpdateAssets200Response | UpdateAssetsDefaultResponse)
isUnexpected(GetAssetResource200Response | GetAssetResourceDefaultResponse)
isUnexpected(ListDataConnection200Response | ListDataConnectionDefaultResponse)
isUnexpected(ValidateDataConnection200Response | ValidateDataConnectionDefaultResponse)
isUnexpected(GetDataConnection200Response | GetDataConnectionDefaultResponse)
isUnexpected(CreateOrReplaceDataConnection200Response | CreateOrReplaceDataConnectionDefaultResponse)
isUnexpected(DeleteDataConnection204Response | DeleteDataConnectionDefaultResponse)
isUnexpected(ListDiscoGroup200Response | ListDiscoGroupDefaultResponse)
isUnexpected(ValidateDiscoGroup200Response | ValidateDiscoGroupDefaultResponse)
isUnexpected(GetDiscoGroup200Response | GetDiscoGroupDefaultResponse)
isUnexpected(CreateOrReplaceDiscoGroup200Response | CreateOrReplaceDiscoGroupDefaultResponse)
isUnexpected(RunDiscoGroup204Response | RunDiscoGroupDefaultResponse)
isUnexpected(ListRuns200Response | ListRunsDefaultResponse)
isUnexpected(ListDiscoTemplate200Response | ListDiscoTemplateDefaultResponse)
isUnexpected(GetDiscoTemplate200Response | GetDiscoTemplateDefaultResponse)
isUnexpected(GetBillable200Response | GetBillableDefaultResponse)
isUnexpected(GetSnapshot200Response | GetSnapshotDefaultResponse)
isUnexpected(GetSummary200Response | GetSummaryDefaultResponse)
isUnexpected(ListSavedFilter200Response | ListSavedFilterDefaultResponse)
isUnexpected(GetSavedFilter200Response | GetSavedFilterDefaultResponse)
isUnexpected(CreateOrReplaceSavedFilter200Response | CreateOrReplaceSavedFilterDefaultResponse)
isUnexpected(DeleteSavedFilter204Response | DeleteSavedFilterDefaultResponse)
isUnexpected(ListTask200Response | ListTaskDefaultResponse)
isUnexpected(GetTask200Response | GetTaskDefaultResponse)
isUnexpected(CancelTask200Response | CancelTaskDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential, EasmClientOptions)

Initialize a new instance of EasmClient

function default(endpointParam: string, credentials: TokenCredential, options?: EasmClientOptions): EasmClient

Parameters

endpointParam

string

The endpoint hosting the requested resource. For example, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}

credentials
TokenCredential

uniquely identify client credential

options
EasmClientOptions

the parameter for all optional parameters

Returns

isUnexpected(ListAssetResource200Response | ListAssetResourceDefaultResponse)

function isUnexpected(response: ListAssetResource200Response | ListAssetResourceDefaultResponse): response

Parameters

Returns

response

isUnexpected(UpdateAssets200Response | UpdateAssetsDefaultResponse)

function isUnexpected(response: UpdateAssets200Response | UpdateAssetsDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetAssetResource200Response | GetAssetResourceDefaultResponse)

function isUnexpected(response: GetAssetResource200Response | GetAssetResourceDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListDataConnection200Response | ListDataConnectionDefaultResponse)

function isUnexpected(response: ListDataConnection200Response | ListDataConnectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(ValidateDataConnection200Response | ValidateDataConnectionDefaultResponse)

function isUnexpected(response: ValidateDataConnection200Response | ValidateDataConnectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetDataConnection200Response | GetDataConnectionDefaultResponse)

function isUnexpected(response: GetDataConnection200Response | GetDataConnectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateOrReplaceDataConnection200Response | CreateOrReplaceDataConnectionDefaultResponse)

function isUnexpected(response: CreateOrReplaceDataConnection200Response | CreateOrReplaceDataConnectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteDataConnection204Response | DeleteDataConnectionDefaultResponse)

function isUnexpected(response: DeleteDataConnection204Response | DeleteDataConnectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListDiscoGroup200Response | ListDiscoGroupDefaultResponse)

function isUnexpected(response: ListDiscoGroup200Response | ListDiscoGroupDefaultResponse): response

Parameters

Returns

response

isUnexpected(ValidateDiscoGroup200Response | ValidateDiscoGroupDefaultResponse)

function isUnexpected(response: ValidateDiscoGroup200Response | ValidateDiscoGroupDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetDiscoGroup200Response | GetDiscoGroupDefaultResponse)

function isUnexpected(response: GetDiscoGroup200Response | GetDiscoGroupDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateOrReplaceDiscoGroup200Response | CreateOrReplaceDiscoGroupDefaultResponse)

function isUnexpected(response: CreateOrReplaceDiscoGroup200Response | CreateOrReplaceDiscoGroupDefaultResponse): response

Parameters

Returns

response

isUnexpected(RunDiscoGroup204Response | RunDiscoGroupDefaultResponse)

function isUnexpected(response: RunDiscoGroup204Response | RunDiscoGroupDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListRuns200Response | ListRunsDefaultResponse)

function isUnexpected(response: ListRuns200Response | ListRunsDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListDiscoTemplate200Response | ListDiscoTemplateDefaultResponse)

function isUnexpected(response: ListDiscoTemplate200Response | ListDiscoTemplateDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetDiscoTemplate200Response | GetDiscoTemplateDefaultResponse)

function isUnexpected(response: GetDiscoTemplate200Response | GetDiscoTemplateDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetBillable200Response | GetBillableDefaultResponse)

function isUnexpected(response: GetBillable200Response | GetBillableDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetSnapshot200Response | GetSnapshotDefaultResponse)

function isUnexpected(response: GetSnapshot200Response | GetSnapshotDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetSummary200Response | GetSummaryDefaultResponse)

function isUnexpected(response: GetSummary200Response | GetSummaryDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListSavedFilter200Response | ListSavedFilterDefaultResponse)

function isUnexpected(response: ListSavedFilter200Response | ListSavedFilterDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetSavedFilter200Response | GetSavedFilterDefaultResponse)

function isUnexpected(response: GetSavedFilter200Response | GetSavedFilterDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateOrReplaceSavedFilter200Response | CreateOrReplaceSavedFilterDefaultResponse)

function isUnexpected(response: CreateOrReplaceSavedFilter200Response | CreateOrReplaceSavedFilterDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteSavedFilter204Response | DeleteSavedFilterDefaultResponse)

function isUnexpected(response: DeleteSavedFilter204Response | DeleteSavedFilterDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListTask200Response | ListTaskDefaultResponse)

function isUnexpected(response: ListTask200Response | ListTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetTask200Response | GetTaskDefaultResponse)

function isUnexpected(response: GetTask200Response | GetTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(CancelTask200Response | CancelTaskDefaultResponse)

function isUnexpected(response: CancelTask200Response | CancelTaskDefaultResponse): response

Parameters

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

  • PagedAsyncIterableIterator to iterate the elements