az logz monitor

  • Experimental
  • Reference

Note

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

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage monitor with logz.

Commands

Name Description Type Status
az logz monitor create

Create a monitor resource. This create operation can take Get to complete.

 Extension Experimental
az logz monitor delete

Delete a monitor resource.

 Extension Experimental
az logz monitor list

List all monitors under the specified resource group. And List all monitors under the specified subscription.

 Extension Experimental
az logz monitor list-payload

List the payload that needs to be passed in the request body for installing Logz.io agent on a VM.

 Extension Experimental
az logz monitor list-resource

List the resources currently being monitored by the Logz monitor resource.

 Extension Experimental
az logz monitor list-role

List the user's roles configured on Logz.io side for the account corresponding to the monitor resource.

 Extension Experimental
az logz monitor list-vm

List the compute resources currently being monitored by the Logz main account resource.

 Extension Experimental
az logz monitor show

Get the properties of a specific monitor resource.

 Extension Experimental
az logz monitor update

Update a monitor resource.

 Extension Experimental
az logz monitor update-vm

Update the collection when Logz.io agent has been installed on a VM for a given monitor.

 Extension Experimental
az logz monitor wait

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

 Extension Experimental

az logz monitor create

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a monitor resource. This create operation can take Get to complete.

az logz monitor create --monitor-name
                       --resource-group
                       [--location]
                       [--monitoring-status {Disabled, Enabled}]
                       [--no-wait]
                       [--org-properties]
                       [--plan-data]
                       [--subscription-status {Active, Suspended}]
                       [--tags]
                       [--type {SystemAssigned, UserAssigned}]
                       [--user-info]

Examples

Monitors_Create

az logz monitor create --name "myMonitor" --location "West US" --plan-data billing-cycle="Monthly" effective-date="2019-08-30T15:14:33+02:00" plan-details="logzapitestplan" usage-type="Committed" --user-info email-address="alice@microsoft.com" first-name="Alice" last-name="Bob" phone-number="123456" --tags Environment="Dev" --resource-group "myResourceGroup"

Required Parameters

--monitor-name --name -n

Monitor resource name.

--resource-group -g

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

Optional Parameters

--location -l

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

--monitoring-status

Flag specifying if the resource monitoring is enabled or disabled.

accepted values: Disabled, Enabled
--no-wait

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

default value: False
--org-properties

Usage: --org-properties company-name=XX enterprise-app-id=XX single-sign-on-url=XX

company-name: Name of the Logz organization. enterprise-app-id: The Id of the Enterprise App used for Single sign on. single-sign-on-url: The login URL specific to this Logz Organization.

--plan-data

Usage: --plan-data usage-type=XX billing-cycle=XX plan-details=XX effective-date=XX

usage-type: different usage type like PAYG/COMMITTED. this could be enum billing-cycle: different billing cycles like MONTHLY/WEEKLY. this could be enum plan-details: plan id as published by Logz effective-date: date when plan was applied.

--subscription-status

Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.

accepted values: Active, Suspended
--tags

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

--type

Identity type.

accepted values: SystemAssigned, UserAssigned
--user-info

Usage: --user-info first-name=XX last-name=XX email-address=XX phone-number=XX

first-name: First Name of the user last-name: Last Name of the user email-address: Email of the user used by Logz for contacting them if needed phone-number: Phone number of the user used by Logz for contacting them if needed.

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 logz monitor delete

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a monitor resource.

az logz monitor delete [--ids]
                       [--monitor-name]
                       [--no-wait]
                       [--resource-group]
                       [--subscription]
                       [--yes]

Examples

Monitors_Delete

az logz monitor delete --name "myMonitor" --resource-group "myResourceGroup"

Optional Parameters

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

--monitor-name --name -n

Monitor resource name.

--no-wait

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

default value: False
--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 logz monitor list

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all monitors under the specified resource group. And List all monitors under the specified subscription.

az logz monitor list [--resource-group]

Examples

Monitors_ListByResourceGroup

az logz monitor list --resource-group "myResourceGroup"

Monitors_List

az logz monitor 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.

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 logz monitor list-payload

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the payload that needs to be passed in the request body for installing Logz.io agent on a VM.

az logz monitor list-payload --monitor-name
                             --resource-group

Examples

MainAccount_VMHosts_Payload

az logz monitor list-payload --name "myMonitor" --resource-group "myResourceGroup"

Required Parameters

--monitor-name --name -n

Monitor resource name.

--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 logz monitor list-resource

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the resources currently being monitored by the Logz monitor resource.

az logz monitor list-resource --monitor-name
                              --resource-group

Examples

MonitoredResources_List

az logz monitor list-resource --name "myMonitor" --resource-group "myResourceGroup"

Required Parameters

--monitor-name --name -n

Monitor resource name.

--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 logz monitor list-role

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the user's roles configured on Logz.io side for the account corresponding to the monitor resource.

az logz monitor list-role --monitor-name
                          --resource-group
                          [--email-address]

Examples

MainAccount_VMHosts_Update

az logz monitor list-role --name "myMonitor" --resource-group "myResourceGroup"

Required Parameters

--monitor-name --name -n

Monitor resource name.

--resource-group -g

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

Optional Parameters

--email-address

Email of the user used by Logz for contacting them if needed.

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 logz monitor list-vm

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the compute resources currently being monitored by the Logz main account resource.

az logz monitor list-vm --monitor-name
                        --resource-group

Examples

MainAccount_VMHosts_List

az logz monitor list-vm --name "myMonitor" --resource-group "myResourceGroup"

Required Parameters

--monitor-name --name -n

Monitor resource name.

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

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the properties of a specific monitor resource.

az logz monitor show [--ids]
                     [--monitor-name]
                     [--resource-group]
                     [--subscription]

Examples

Monitors_Get

az logz monitor show --name "myMonitor" --resource-group "myResourceGroup"

Optional Parameters

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

--monitor-name --name -n

Monitor resource name.

--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 logz monitor update

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a monitor resource.

az logz monitor update [--ids]
                       [--monitor-name]
                       [--monitoring-status {Disabled, Enabled}]
                       [--resource-group]
                       [--subscription]
                       [--tags]

Examples

Monitors_Update

az logz monitor update --name "myMonitor" --monitoring-status "Enabled" --tags Environment="Dev" --resource-group "myResourceGroup"

Optional Parameters

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

--monitor-name --name -n

Monitor resource name.

--monitoring-status

Flag specifying if the resource monitoring is enabled or disabled.

accepted values: Disabled, Enabled
--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.

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

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 logz monitor update-vm

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the collection when Logz.io agent has been installed on a VM for a given monitor.

az logz monitor update-vm [--ids]
                          [--monitor-name]
                          [--resource-group]
                          [--state {Delete, Install}]
                          [--subscription]
                          [--vm-resource-ids]

Examples

MainAccount_VMHosts_Update

az logz monitor update-vm --name "myMonitor" --state "Install" --resource-group "myResourceGroup"

Optional Parameters

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

--monitor-name --name -n

Monitor resource name.

--resource-group -g

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

--state

Specifies the state of the operation - install/ delete.

accepted values: Delete, Install
--subscription

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

--vm-resource-ids

Request of a list vm host update operation.

Usage: --vm-resource-ids id=XX agent-version=XX

id: Request of a list vm host update operation. agent-version: Version of the Logz agent installed on the VM.

Multiple actions can be specified by using more than one --vm-resource-ids argument.

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 logz monitor wait

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

Pause executing next line of CLI script until the logz monitor is successfully created.

az logz monitor wait --name "myMonitor" --resource-group "myResourceGroup" --created

Pause executing next line of CLI script until the logz monitor is successfully deleted.

az logz monitor wait --name "myMonitor" --resource-group "myResourceGroup" --deleted

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

Monitor resource name.

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