az security assessment

View your security assessment results.

Commands

Name	Description	Type	Status
az security assessment create	Creates a customer managed security assessment.	Core	GA
az security assessment delete	Deletes a security assessment.	Core	GA
az security assessment list	List all security assessment results.	Core	GA
az security assessment show	Shows a security assessment.	Core	GA

az security assessment create

Creates a customer managed security assessment.

az security assessment create --name
                              --status-code
                              [--additional-data]
                              [--assessed-resource-id]
                              [--status-cause]
                              [--status-description]

Examples

Creates a security assessment.

az security assessment create -n '4fb6c0a0-1137-42c7-a1c7-4bd37c91de8d' --status-code  'unhealthy'

Required Parameters

--name -n

Name of the resource to be fetched.

--status-code

Programmatic code for the result of the assessment. can be "Healthy", "Unhealthy" or "NotApplicable".

Optional Parameters

--additional-data

Data that is attached to the assessment result for better investigations or status clarity.

--assessed-resource-id

The target resource for this assessment.

--status-cause

Programmatic code for the cause of the assessment result.

--status-description

Human readable description of the cause of the assessment result.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az security assessment delete

Deletes a security assessment.

az security assessment delete --name
                              [--assessed-resource-id]

Examples

Deletes a security assessment.

az security assessment delete -n '4fb6c0a0-1137-42c7-a1c7-4bd37c91de8d'

Required Parameters

--name -n

Name of the resource to be fetched.

Optional Parameters

--assessed-resource-id

The target resource for this assessment.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az security assessment list

List all security assessment results.

az security assessment list

Examples

Get security assessments.

az security assessment list

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az security assessment show

Shows a security assessment.

az security assessment show --name
                            [--assessed-resource-id]

Examples

Get a security assessment.

az security assessment show -n '4fb6c0a0-1137-42c7-a1c7-4bd37c91de8d'

Required Parameters

--name -n

Name of the resource to be fetched.

Optional Parameters

--assessed-resource-id

The target resource for this assessment.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.