Share via

SecurityCenterExtensions.GetSecurityHealthReport Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.SecurityCenter
Assembly:
Azure.ResourceManager.SecurityCenter.dll
Package:
Azure.ResourceManager.SecurityCenter v1.2.0-beta.5
Source:
SecurityCenterExtensions.cs

Get health report of resource

  • Request Path: /{resourceId}/providers/Microsoft.Security/healthReports/{healthReportName}
  • Operation Id: HealthReports_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: SecurityHealthReportResource
public static Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityHealthReportResource> GetSecurityHealthReport (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string healthReportName, System.Threading.CancellationToken cancellationToken = default);
static member GetSecurityHealthReport : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityHealthReportResource>
<Extension()>
Public Function GetSecurityHealthReport (client As ArmClient, scope As ResourceIdentifier, healthReportName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SecurityHealthReportResource)

Parameters

client
ArmClient

The ArmClient instance the method will execute against.

scope
ResourceIdentifier

The scope that the resource will apply against.

healthReportName
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<SecurityHealthReportResource>

Exceptions

ArgumentNullException

client or healthReportName is null.

ArgumentException

healthReportName is an empty string, and was expected to be non-empty.

Applies to