Share via

HealthReports interface

  • Reference
Package:
@azure/arm-security

Interface representing a HealthReports.

Methods

get(string, string, HealthReportsGetOptionalParams)

Get health report of resource
list(string, HealthReportsListOptionalParams)

Get a list of all health reports inside a scope. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

Method Details

get(string, string, HealthReportsGetOptionalParams)

Get health report of resource

function get(resourceId: string, healthReportName: string, options?: HealthReportsGetOptionalParams): Promise<HealthReport>

Parameters

resourceId

string

The identifier of the resource.

healthReportName

string

The health report Key - Unique key for the health report type

options
HealthReportsGetOptionalParams

The options parameters.

Returns

Promise<HealthReport>

list(string, HealthReportsListOptionalParams)

Get a list of all health reports inside a scope. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

function list(scope: string, options?: HealthReportsListOptionalParams): PagedAsyncIterableIterator<HealthReport, HealthReport[], PageSettings>

Parameters

scope

string

The scope at which the operation is performed.

options
HealthReportsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HealthReport, HealthReport[], PageSettings>