az monitor log-analytics cluster

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage Azure log analytics cluster.

Commands

az monitor log-analytics cluster create	Create a cluster instance.
az monitor log-analytics cluster delete	Delete a cluster instance.
az monitor log-analytics cluster list	Gets all cluster instances in a resource group or in current subscription.
az monitor log-analytics cluster show	Show the properties of a cluster instance.
az monitor log-analytics cluster update	Update a cluster instance.
az monitor log-analytics cluster wait	Place the CLI in a waiting state until a condition of the cluster is met.

az monitor log-analytics cluster create

Create a cluster instance.

az monitor log-analytics cluster create --name
                                        --resource-group
                                        --sku-capacity
                                        [--identity-type]
                                        [--location]
                                        [--no-wait]
                                        [--sku-name]
                                        [--tags]

Examples

Create a cluster instance.

az monitor log-analytics cluster create -g MyResourceGroup -n MyCluster --sku-capacity 1000

Required Parameters

--name -n

The name of the Log Analytics cluster.

--resource-group -g

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

--sku-capacity

The capacity of the SKU. It must be in the range of 1000-2000 per day and must be in multiples of 100. If you want to increase the limit, please contact LAIngestionRate@microsoft.com. It can be decreased only after 31 days.

Optional Parameters

--identity-type

The identity type. Supported values: SystemAssigned.

default value: SystemAssigned

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--sku-name

The name of the SKU. Currently only support 'CapacityReservation'.

default value: CapacityReservation

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

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

Delete a cluster instance.

az monitor log-analytics cluster delete --name
                                        --resource-group
                                        [--no-wait]
                                        [--yes]

Examples

Delete a cluster instance.

az monitor log-analytics cluster delete -g MyResourceGroup -n MyCluster

Required Parameters

--name -n

The name of the Log Analytics cluster.

--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.

--yes -y

Do not prompt for confirmation.

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.

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

Gets all cluster instances in a resource group or in current subscription.

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

Examples

Gets all cluster instances in a resource group.

az monitor log-analytics cluster list -g MyResourceGroup

Gets all cluster instances in current subscription.

az monitor log-analytics cluster list

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.

--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 cluster show

Show the properties of a cluster instance.

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

Examples

Show the properties of a cluster instance.

az monitor log-analytics cluster show -g MyResourceGroup -n MyCluster

Required Parameters

--name -n

The name of the Log Analytics cluster.

--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.

--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 cluster update

Update a cluster instance.

az monitor log-analytics cluster update --name
                                        --resource-group
                                        [--key-name]
                                        [--key-vault-uri]
                                        [--key-version]
                                        [--no-wait]
                                        [--sku-capacity]
                                        [--tags]

Examples

Update a cluster instance.

az monitor log-analytics cluster update -g MyResourceGroup -n MyCluster \
  --key-vault-uri https://myvault.vault.azure.net/ --key-name my-key \
  --key-version fe0adcedd8014aed9c22e9aefb81a1ds --sku-capacity 1000

Required Parameters

--name -n

The name of the Log Analytics cluster.

--resource-group -g

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

Optional Parameters

--key-name

The name of the key associated with the Log Analytics cluster.

--key-vault-uri

The Key Vault uri which holds the key associated with the Log Analytics cluster.

--key-version

The version of the key associated with the Log Analytics cluster.

--no-wait

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

--sku-capacity

The capacity of the SKU. It must be in the range of 1000-2000 per day and must be in multiples of 100. If you want to increase the limit, please contact LAIngestionRate@microsoft.com. It can be decreased only after 31 days.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--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 cluster wait

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

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

Examples

Pause executing next line of CLI script until the cluster is successfully provisioned.

az monitor log-analytics cluster wait -n MyCluster -g MyResourceGroup --created

Required Parameters

--name -n

The name of the Log Analytics cluster.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

--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.