SecurityCenterExtensions.GetSecurityAssessmentAsync Method

Definition

Namespace:

Azure.ResourceManager.SecurityCenter

Assembly:

Azure.ResourceManager.SecurityCenter.dll

Package:

Azure.ResourceManager.SecurityCenter v1.1.0

Source:

SecurityCenterExtensions.cs

Get a security assessment on your scanned resource

• Request Path: /{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}
• Operation Id: Assessments_Get
• Default Api Version: 2021-06-01
• Resource: SecurityAssessmentResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityAssessmentResource>> GetSecurityAssessmentAsync (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string assessmentName, Azure.ResourceManager.SecurityCenter.Models.SecurityAssessmentODataExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);

static member GetSecurityAssessmentAsync : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * Nullable<Azure.ResourceManager.SecurityCenter.Models.SecurityAssessmentODataExpand> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SecurityCenter.SecurityAssessmentResource>>

<Extension()>
Public Function GetSecurityAssessmentAsync (client As ArmClient, scope As ResourceIdentifier, assessmentName As String, Optional expand As Nullable(Of SecurityAssessmentODataExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SecurityAssessmentResource))

Parameters

client

ArmClient

The ArmClient instance the method will execute against.

scope

ResourceIdentifier

The scope that the resource will apply against.

assessmentName

String

The Assessment Key - Unique key for the assessment type.

expand

Nullable<SecurityAssessmentODataExpand>

OData expand. Optional.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<SecurityAssessmentResource>>

Exceptions

ArgumentNullException

client or assessmentName is null.

ArgumentException

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