az monitor log-analytics cluster
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
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 1000Required Parameters
The name of the Log Analytics cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The cluster's billing type.
Type of managed service identity.
The name of the key associated with the Log Analytics cluster.
Selected key minimum required size.
The Key Vault uri which holds they key associated with the Log Analytics cluster.
The version of the key associated with the Log Analytics cluster.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
The capacity of the SKU. It can be decreased only after 31 days.
The name of the SKU.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 [--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 MyClusterOptional Parameters
Name of the Log Analytics Cluster.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor log-analytics cluster list
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 MyResourceGroupList all cluster instances in current subscription.
az monitor log-analytics cluster listOptional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 [--cluster-name]
[--ids]
[--resource-group]
[--subscription]Examples
Show the properties of a cluster instance.
az monitor log-analytics cluster show -g MyResourceGroup -n MyClusterOptional Parameters
Name of the Log Analytics Cluster.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 [--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 1000Optional Parameters
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>.
The cluster's billing type.
Name of the Log Analytics Cluster.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Type of managed service identity.
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.
The name of the key associated with the Log Analytics cluster.
Selected key minimum required size.
The Key Vault uri which holds they key associated with the Log Analytics cluster.
The version of the key associated with the Log Analytics cluster.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
The capacity of the SKU. It can be decreased only after 31 days.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 is met.
az monitor log-analytics cluster wait [--cluster-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Name of the Log Analytics Cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for