az monitor account

Manage monitor account.

Commands

Name Description Type Status
az monitor account create

Create a workspace.

Core GA
az monitor account delete

Delete a workspace.

Core GA
az monitor account identity

Manage Identity.

Core GA
az monitor account identity assign

Assign the user or system managed identities.

Core GA
az monitor account identity remove

Remove the user or system managed identities.

Core GA
az monitor account identity show

Show the details of managed identities.

Core GA
az monitor account issue

Manage Issue.

Core GA
az monitor account issue add-investigation-result

Adds investigation result.

Core GA
az monitor account issue add-or-update-alert

Add or update alerts in the issue.

Core GA
az monitor account issue add-or-update-resource

Add or update resources in the issue.

Core GA
az monitor account issue create

Create a new issue or updates an existing one.

Core GA
az monitor account issue delete

Delete an issue.

Core GA
az monitor account issue fetch-background-visualization

Fetch the background visualization of the issue.

Core GA
az monitor account issue fetch-investigation-result

Fetch investigation result.

Core GA
az monitor account issue list

List all issues under the parent.

Core GA
az monitor account issue list-alert

List all alerts in the issue - this method uses pagination to return all alerts.

Core GA
az monitor account issue list-resource

List all resources in the issue - this method uses pagination to return all resources.

Core GA
az monitor account issue set-background-visualization

Set the background visualization for the issue.

Core GA
az monitor account issue show

Get issue properties.

Core GA
az monitor account issue update

Update a new issue or updates an existing one.

Core GA
az monitor account list

List all workspaces in the specified subscription.

Core GA
az monitor account metrics-container

Manage Metrics Container.

Core GA
az monitor account metrics-container create

Create metrics container settings for a monitoring account.

Core GA
az monitor account metrics-container list

List metrics containers for a monitoring account.

Core GA
az monitor account metrics-container show

Get metrics container settings for a monitoring account.

Core GA
az monitor account metrics-container update

Update metrics container settings for a monitoring account.

Core GA
az monitor account show

Show the specific azure monitor workspace.

Core GA
az monitor account update

Update a workspace.

Core GA
az monitor account wait

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

Core GA

az monitor account create

Create a workspace.

az monitor account create --azure-monitor-workspace-name --name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--enable-access-using-resource-permissions --enable-res-perm {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--mi-system-assigned --system-assigned]
                          [--mi-user-assigned --user-assigned]
                          [--public-network-access {Disabled, Enabled}]
                          [--tags]

Examples

Create monitor account

az monitor account create -n account-name -g rg

Required Parameters

--azure-monitor-workspace-name --name -n

The name of the Azure Monitor workspace. The name is case insensitive.

--resource-group -g

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

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
--enable-access-using-resource-permissions --enable-res-perm

Flag that indicates whether to enable access using resource permissions.

Property Value
Parameter group: Metrics Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

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

Property Value
Parameter group: Resource Arguments
--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--public-network-access

Gets or sets allow or disallow public network access to Azure Monitor Workspace.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--tags

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

Property Value
Parameter group: Resource 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 monitor account delete

Delete a workspace.

az monitor account delete [--acquire-policy-token]
                          [--azure-monitor-workspace-name --name]
                          [--change-reference]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Delete monitor account

az monitor account delete -n account-name -g rg

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
--azure-monitor-workspace-name --name -n

The name of the Azure Monitor workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az monitor account list

List all workspaces in the specified subscription.

az monitor account list [--max-items]
                        [--next-token]
                        [--resource-group]

Examples

List monitor account by resource group

az monitor account list -g rg

Optional Parameters

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

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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.

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 monitor account show

Show the specific azure monitor workspace.

az monitor account show [--azure-monitor-workspace-name --name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

Examples

Show monitor account

az monitor account show -n account -g rg

Optional Parameters

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

--azure-monitor-workspace-name --name -n

The name of the Azure Monitor workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az monitor account update

Update a workspace.

az monitor account update [--acquire-policy-token]
                          [--add]
                          [--azure-monitor-workspace-name --name]
                          [--change-reference]
                          [--enable-access-using-resource-permissions --enable-res-perm {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--public-network-access {Disabled, Enabled}]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]
                          [--tags]

Examples

Update monitor account tags

az monitor account update -n account-name -g rg --tags "{tag:test}"

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

Property Value
Parameter group: Generic Update Arguments
--azure-monitor-workspace-name --name -n

The name of the Azure Monitor workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--enable-access-using-resource-permissions --enable-res-perm

Flag that indicates whether to enable access using resource permissions.

Property Value
Parameter group: Metrics Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--public-network-access

Gets or sets allow or disallow public network access to Azure Monitor Workspace.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

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

Property Value
Parameter group: Resource 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az monitor account wait

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

az monitor account wait [--acquire-policy-token]
                        [--azure-monitor-workspace-name --name]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

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
--azure-monitor-workspace-name --name -n

The name of the Azure Monitor workspace. The name is case insensitive.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False