Share via


AssessmentsOperations interface

Interface representing a AssessmentsOperations.

Methods

beginCreate(string, string, string, string, Assessment, AssessmentsOperationsCreateOptionalParams)

Create a Assessment

beginCreateAndWait(string, string, string, string, Assessment, AssessmentsOperationsCreateOptionalParams)

Create a Assessment

beginDownloadUrl(string, string, string, string, Record<string, unknown>, AssessmentsOperationsDownloadUrlOptionalParams)

Get the URL for downloading the assessment in a report format.

beginDownloadUrlAndWait(string, string, string, string, Record<string, unknown>, AssessmentsOperationsDownloadUrlOptionalParams)

Get the URL for downloading the assessment in a report format.

delete(string, string, string, string, AssessmentsOperationsDeleteOptionalParams)

Delete a Assessment

get(string, string, string, string, AssessmentsOperationsGetOptionalParams)

Get a Assessment

listByGroup(string, string, string, AssessmentsOperationsListByGroupOptionalParams)

List Assessment resources by Group

Method Details

beginCreate(string, string, string, string, Assessment, AssessmentsOperationsCreateOptionalParams)

Create a Assessment

function beginCreate(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, resource: Assessment, options?: AssessmentsOperationsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Assessment>, Assessment>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

resource
Assessment

Resource create parameters.

options
AssessmentsOperationsCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Assessment>, Assessment>>

beginCreateAndWait(string, string, string, string, Assessment, AssessmentsOperationsCreateOptionalParams)

Create a Assessment

function beginCreateAndWait(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, resource: Assessment, options?: AssessmentsOperationsCreateOptionalParams): Promise<Assessment>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

resource
Assessment

Resource create parameters.

options
AssessmentsOperationsCreateOptionalParams

The options parameters.

Returns

Promise<Assessment>

beginDownloadUrl(string, string, string, string, Record<string, unknown>, AssessmentsOperationsDownloadUrlOptionalParams)

Get the URL for downloading the assessment in a report format.

function beginDownloadUrl(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, body: Record<string, unknown>, options?: AssessmentsOperationsDownloadUrlOptionalParams): Promise<SimplePollerLike<OperationState<DownloadUrl>, DownloadUrl>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

body

Record<string, unknown>

The content of the action request

options
AssessmentsOperationsDownloadUrlOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DownloadUrl>, DownloadUrl>>

beginDownloadUrlAndWait(string, string, string, string, Record<string, unknown>, AssessmentsOperationsDownloadUrlOptionalParams)

Get the URL for downloading the assessment in a report format.

function beginDownloadUrlAndWait(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, body: Record<string, unknown>, options?: AssessmentsOperationsDownloadUrlOptionalParams): Promise<DownloadUrl>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

body

Record<string, unknown>

The content of the action request

options
AssessmentsOperationsDownloadUrlOptionalParams

The options parameters.

Returns

Promise<DownloadUrl>

delete(string, string, string, string, AssessmentsOperationsDeleteOptionalParams)

Delete a Assessment

function delete(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsOperationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

options
AssessmentsOperationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, AssessmentsOperationsGetOptionalParams)

Get a Assessment

function get(resourceGroupName: string, projectName: string, groupName: string, assessmentName: string, options?: AssessmentsOperationsGetOptionalParams): Promise<Assessment>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

assessmentName

string

Machine Assessment ARM name

options
AssessmentsOperationsGetOptionalParams

The options parameters.

Returns

Promise<Assessment>

listByGroup(string, string, string, AssessmentsOperationsListByGroupOptionalParams)

List Assessment resources by Group

function listByGroup(resourceGroupName: string, projectName: string, groupName: string, options?: AssessmentsOperationsListByGroupOptionalParams): PagedAsyncIterableIterator<Assessment, Assessment[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

Assessment Project Name

groupName

string

Group ARM name

options
AssessmentsOperationsListByGroupOptionalParams

The options parameters.

Returns