Share via

az logz sub-account

  • 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 sub-account command. Learn more about extensions.

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

Manage sub account with logz.

Commands

Name Description Type Status
az logz sub-account create

Create sub account under a given monitor resource.

 Extension Experimental
az logz sub-account delete

Delete a sub account resource.

 Extension Experimental
az logz sub-account list

List the sub account under a given monitor resource.

 Extension Experimental
az logz sub-account list-payload

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

 Extension Experimental
az logz sub-account list-resource

List the resources currently being monitored by the Logz sub account resource.

 Extension Experimental
az logz sub-account list-vm

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

 Extension Experimental
az logz sub-account show

Get a sub account under a given monitor resource.

 Extension Experimental
az logz sub-account update

Update a monitor resource.

 Extension Experimental
az logz sub-account update-vm

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

 Extension Experimental
az logz sub-account wait

Place the CLI in a waiting state until a condition of the logz sub-account is met.

 Extension Experimental

az logz sub-account create

Experimental

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

Create sub account under a given monitor resource.

az logz sub-account create --monitor-name
                           --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

subAccount_Create

az logz sub-account create --monitor-name "myMonitor" --type "Microsoft.Logz/monitors" --location "West US" --monitoring-status "Enabled" --tags Environment="Dev" --resource-group "myResourceGroup" --name "SubAccount1"

Required Parameters

--monitor-name

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account delete

Experimental

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

Delete a sub account resource.

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

Examples

SubAccount_Delete

az logz sub-account delete --monitor-name "myMonitor" --resource-group "myResourceGroup" --name "someName"

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

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account list

Experimental

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

List the sub account under a given monitor resource.

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

Examples

SubAccount_List

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

Required Parameters

--monitor-name

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 sub-account 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 as a request for installing Logz.io agent on a VM.

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

Examples

SubAccount_VMHosts_Payload

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

Required Parameters

--monitor-name

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account 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 sub account resource.

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

Examples

SubAccount_MonitoredResources_List

az logz sub-account list-resource --monitor-name "myMonitor" --resource-group "myResourceGroup" --name "SubAccount1"

Required Parameters

--monitor-name

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account 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 sub account resource.

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

Examples

SubAccount_VMHosts_List

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

Required Parameters

--monitor-name

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account show

Experimental

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

Get a sub account under a given monitor resource.

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

Examples

SubAccount_Get

az logz sub-account show --monitor-name "myMonitor" --resource-group "myResourceGroup" --name "SubAccount1"

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

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account 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 sub-account update [--ids]
                           [--monitor-name]
                           [--monitoring-status {Disabled, Enabled}]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--tags]

Examples

SubAccount_Update

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

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

Monitor resource name.

--monitoring-status

Flag specifying if the resource monitoring is enabled or disabled.

Accepted values: Disabled, Enabled
--name --sub-account-name -n

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

--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 sub-account 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 sub-account update-vm [--ids]
                              [--monitor-name]
                              [--name]
                              [--resource-group]
                              [--state {Delete, Install}]
                              [--subscription]
                              [--vm-resource-ids]

Examples

SubAccount_VMHosts_Update

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

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

Monitor resource name.

--name --sub-account-name -n

Sub Account 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 sub-account 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 sub-account is met.

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

Examples

Pause executing next line of CLI script until the logz sub-account is successfully created.

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

Pause executing next line of CLI script until the logz sub-account is successfully deleted.

az logz sub-account wait --monitor-name "myMonitor" --resource-group "myResourceGroup" --name "SubAccount1" --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

Monitor resource name.

--name --sub-account-name -n

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