Share via


az security workspace-setting

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data.

Commands

Name Description Type Status
az security workspace-setting create

Creates a workspace settings in your subscription - these settings let you control which workspace will hold your security data.

Core GA
az security workspace-setting delete

Deletes the workspace settings in your subscription - this will make the security events on the subscription be reported to the default workspace.

Core GA
az security workspace-setting list

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data.

Core GA
az security workspace-setting show

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data.

Core GA

az security workspace-setting create

Creates a workspace settings in your subscription - these settings let you control which workspace will hold your security data.

az security workspace-setting create --name
                                     --target-workspace
                                     [--acquire-policy-token]
                                     [--change-reference]

Examples

Creates a workspace settings in your subscription - these settings let you control which workspace will hold your security data

az security workspace-setting create -n default --target-workspace '/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace'

Required Parameters

--name -n

Name of the resource to be fetched.

--target-workspace

An ID of the workspace resource that will hold the security data.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az security workspace-setting delete

Deletes the workspace settings in your subscription - this will make the security events on the subscription be reported to the default workspace.

az security workspace-setting delete --name
                                     [--acquire-policy-token]
                                     [--change-reference]

Examples

Deletes the workspace settings in your subscription - this will make the security events on the subscription be reported to the default workspace

az security workspace-setting delete -n default

Required Parameters

--name -n

Name of the resource to be fetched.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az security workspace-setting list

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data.

az security workspace-setting list

Examples

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data

az security workspace-setting list
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az security workspace-setting show

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data.

az security workspace-setting show --name

Examples

Shows the workspace settings in your subscription - these settings let you control which workspace will hold your security data

az security workspace-setting show -n default

Required Parameters

--name -n

Name of the resource to be fetched.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False