az monitor log-analytics solution

Note

This reference is part of the log-analytics-solution extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az monitor log-analytics solution command. Learn more about extensions.

Commands to manage monitor log-analytics solution.

Commands

Name	Description	Type	Status
az monitor log-analytics solution create	Create the Solution.	Extension	GA
az monitor log-analytics solution delete	Delete the solution in the subscription.	Extension	GA
az monitor log-analytics solution list	List the solution list. It will retrieve both first party and third party solutions.	Extension	GA
az monitor log-analytics solution show	Get the user solution.	Extension	GA
az monitor log-analytics solution update	Update a Solution. Only updating tags supported.	Extension	GA
az monitor log-analytics solution wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az monitor log-analytics solution create

Create the Solution.

az monitor log-analytics solution create --resource-group
                                         --solution-type
                                         --workspace
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]

Examples

Create a log-analytics solution of type Containers

az monitor log-analytics solution create --resource-group MyResourceGroup --solution-type Containers --tags key=value --workspace "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/ Microsoft.OperationalInsights/workspaces/{WorkspaceName}"

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--solution-type -t

Type of the log-analytics solution. The most used are: SecurityCenterFree, Security, Updates, ContainerInsights, ServiceMap, AzureActivity, ChangeTracking, VMInsights, SecurityInsights, NetworkMonitoring, SQLVulnerabilityAssessment, SQLAdvancedThreatProtection, AntiMalware, AzureAutomation, LogicAppsManagement, SQLDataClassification.

--workspace -w

The name or resource ID of the log analytics workspace with which the solution will be linked.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 monitor log-analytics solution delete

Delete the solution in the subscription.

az monitor log-analytics solution delete --name
                                         --resource-group
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--yes]

Examples

Delete a log-analytics solution

az monitor log-analytics solution delete --resource-group MyResourceGroup --name SolutionName

Required Parameters

--name -n

Name of the log-analytics solution. It should be in the format of solutionType(workspaceName). SolutionType part is case sensitive.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--yes -y

Do not prompt for confirmation.

default value: False

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 monitor log-analytics solution list

List the solution list. It will retrieve both first party and third party solutions.

az monitor log-analytics solution list [--resource-group]

Examples

List all log-analytics solutions in the current subscription

az monitor log-analytics solution list

List all log-analytics solutions in a subscription

az monitor log-analytics solution list --subscription MySubscription

List all log-analytics solutions in a resource group

az monitor log-analytics solution list --resource-group MyResourceGroup

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 monitor log-analytics solution show

Get the user solution.

az monitor log-analytics solution show --name
                                       --resource-group

Examples

Show a log-analytics solution

az monitor log-analytics solution show --resource-group MyResourceGroup --name SolutionName

Required Parameters

--name -n

Name of the log-analytics solution. It should be in the format of solutionType(workspaceName). SolutionType part is case sensitive.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 monitor log-analytics solution update

Update a Solution. Only updating tags supported.

az monitor log-analytics solution update --name
                                         --resource-group
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]

Examples

Update a log-analytics solution

az monitor log-analytics solution update --resource-group MyResourceGroup --name SolutionName --tags key=value

Required Parameters

--name -n

Name of the log-analytics solution. It should be in the format of solutionType(workspaceName). SolutionType part is case sensitive.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 monitor log-analytics solution wait

Place the CLI in a waiting state until a condition is met.

az monitor log-analytics solution wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30

--name -n

Name of the log-analytics solution. It should be in the format of solutionType(workspaceName). SolutionType part is case sensitive.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

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.