Del via

az monitor log-analytics cluster

  • Reference

Manage Azure log analytics cluster.

Commands

Name Description Type Status
az monitor log-analytics cluster create

Create a cluster instance.

 Core GA
az monitor log-analytics cluster delete

Delete a cluster instance.

 Core GA
az monitor log-analytics cluster list

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

 Core GA
az monitor log-analytics cluster show

Show the properties of a cluster instance.

 Core GA
az monitor log-analytics cluster update

Update a cluster instance.

 Core GA
az monitor log-analytics cluster wait

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

 Core GA

az monitor log-analytics cluster create

Edit

Create a cluster instance.

az monitor log-analytics cluster create --cluster-name
                                        --resource-group
                                        [--billing-type {Cluster, Workspaces}]
                                        [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                        [--key-name]
                                        [--key-rsa-size]
                                        [--key-vault-uri]
                                        [--key-version]
                                        [--location]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--sku-capacity {100, 1000, 10000, 200, 2000, 25000, 300, 400, 500, 5000, 50000}]
                                        [--sku-name {CapacityReservation}]
                                        [--tags]
                                        [--user-assigned]

Examples

Create a cluster instance.

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

Required Parameters

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

--billing-type

The cluster's billing type.

Accepted values: Cluster, Workspaces
--identity-type

Type of managed service identity.

Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
Default value: SystemAssigned
--key-name

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

--key-rsa-size

Selected key minimum required size.

--key-vault-uri

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

--key-version

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

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--sku-capacity

The capacity of the SKU. It can be decreased only after 31 days.

Accepted values: 100, 1000, 10000, 200, 2000, 25000, 300, 400, 500, 5000, 50000
--sku-name

The name of the SKU.

Accepted values: CapacityReservation
Default value: CapacityReservation
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. 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 cluster delete

Edit

Delete a cluster instance.

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

Examples

Delete a cluster instance.

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

Optional Parameters

--cluster-name --name -n

Name of the Log Analytics Cluster.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

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

Edit

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

az monitor log-analytics cluster list [--max-items]
                                      [--next-token]
                                      [--resource-group]

Examples

List all cluster instances in a resource group.

az monitor log-analytics cluster list -g MyResourceGroup

List all cluster instances in current subscription.

az monitor log-analytics cluster list

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Edit

Show the properties of a cluster instance.

az monitor log-analytics cluster show [--cluster-name]
                                      [--ids]
                                      [--resource-group]
                                      [--subscription]

Examples

Show the properties of a cluster instance.

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

Optional Parameters

--cluster-name --name -n

Name of the Log Analytics Cluster.

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

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

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

Edit

Update a cluster instance.

az monitor log-analytics cluster update [--add]
                                        [--billing-type {Cluster, Workspaces}]
                                        [--cluster-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                        [--ids]
                                        [--key-name]
                                        [--key-rsa-size]
                                        [--key-vault-uri]
                                        [--key-version]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--sku-capacity {100, 1000, 10000, 200, 2000, 25000, 300, 400, 500, 5000, 50000}]
                                        [--subscription]
                                        [--tags]
                                        [--user-assigned]

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--billing-type

The cluster's billing type.

Accepted values: Cluster, Workspaces
--cluster-name --name -n

Name of the Log Analytics Cluster.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Type of managed service identity.

Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--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.

--key-name

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

--key-rsa-size

Selected key minimum required size.

--key-vault-uri

The Key Vault uri which holds they 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.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--sku-capacity

The capacity of the SKU. It can be decreased only after 31 days.

Accepted values: 100, 1000, 10000, 200, 2000, 25000, 300, 400, 500, 5000, 50000
--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. 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 cluster wait

Edit

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

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

Optional Parameters

--cluster-name --name -n

Name of the Log Analytics Cluster.

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