az security assessment-metadata

  • Reference

View your security assessment metadata.

Commands

Name Description Type Status
az security assessment-metadata create

Creates a customer managed security assessment type.

 Core GA
az security assessment-metadata delete

Deletes a security assessment type and all it's assessment results.

 Core GA
az security assessment-metadata list

List all security assessment results.

 Core GA
az security assessment-metadata show

Shows a security assessment.

 Core GA

az security assessment-metadata create

Edit

Creates a customer managed security assessment type.

az security assessment-metadata create --description
                                       --display-name
                                       --name
                                       --severity
                                       [--remediation-description]

Examples

Creates a security assessment type.

az security assessment-metadata create -n "4fb6c0a0-1137-42c7-a1c7-4bd37c91de8d" --display-name  "Resource should be secured" --severity "high" --description "The resource should be secured according to my company security policy"

Required Parameters

--description

Detailed string that will help users to understand the assessment and how it is calculated.

--display-name

Human readable title for this object.

--name -n

Name of the resource to be fetched.

--severity

Indicates the importance of the security risk if the assessment is unhealthy.

Optional Parameters

--remediation-description

Detailed string that will help users to understand the different ways to mitigate or fix the security issue.

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-metadata delete

Edit

Deletes a security assessment type and all it's assessment results.

az security assessment-metadata delete --name

Examples

Deletes a security assessment type.

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

Required Parameters

--name -n

Name of the resource to be fetched.

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-metadata list

Edit

List all security assessment results.

az security assessment-metadata list

Examples

Get security assessment metadata.

az security assessment-metadata 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-metadata show

Edit

Shows a security assessment.

az security assessment-metadata show --name

Examples

Get a security assessment metadata.

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

Required Parameters

--name -n

Name of the resource to be fetched.

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.