Del via


az dynatrace monitor

Note

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

Manage dynatrace monitor.

Commands

Name Description Type Status
az dynatrace monitor create

Create a monitor resource.

Extension GA
az dynatrace monitor delete

Delete a monitor resource.

Extension GA
az dynatrace monitor get-sso-detail

Get the SSO configuration details from the partner.

Extension GA
az dynatrace monitor get-vm-host-payload

Return the payload that need to be passed in the request body for installing Dynatrace agent on a VM.

Extension GA
az dynatrace monitor list

List all monitor resource by monitor name in a resource group.

Extension GA
az dynatrace monitor list-app-service

Get list of app services with dynatrace PaaS OneAgent enabled.

Extension GA
az dynatrace monitor list-host

List the compute resources currently being monitored by the dynatrace resource.

Extension GA
az dynatrace monitor list-linkable-environment

Get all the dynatrace environments that a user can link a azure resource to.

Extension GA
az dynatrace monitor list-monitored-resource

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

Extension GA
az dynatrace monitor show

Show a monitor resource.

Extension GA
az dynatrace monitor sso-config

Manage monitor sso-config.

Extension GA
az dynatrace monitor sso-config create

Create a dynatrace sso-config resource.

Extension GA
az dynatrace monitor sso-config list

List all dynatrace sso-config by monitor name.

Extension GA
az dynatrace monitor sso-config show

Show a dynatrace sso-config.

Extension GA
az dynatrace monitor sso-config wait

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

Extension GA
az dynatrace monitor tag-rule

Manage dynatrace monitor tag-rule.

Extension GA
az dynatrace monitor tag-rule create

Create a tag rule.

Extension GA
az dynatrace monitor tag-rule delete

Delete a tag rule.

Extension GA
az dynatrace monitor tag-rule list

List all tag rule by monitor name.

Extension GA
az dynatrace monitor tag-rule show

Show a tag rule.

Extension GA
az dynatrace monitor tag-rule update

Update a tag rule.

Extension GA
az dynatrace monitor tag-rule wait

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

Extension GA
az dynatrace monitor update

Update a monitor resource.

Extension GA
az dynatrace monitor wait

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

Extension GA

az dynatrace monitor create

Create a monitor resource.

az dynatrace monitor create --monitor-name
                            --resource-group
                            [--environment]
                            [--identity]
                            [--location]
                            [--monitoring-status {Disabled, Enabled}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--plan-data]
                            [--subscription-status {Active, Suspended}]
                            [--tags]
                            [--user-info]

Examples

Create a monitor

az dynatrace monitor create -g rg -n monitor --user-info "{first-name:Alice,last-name:Bobab,email-address:Alice@microsoft.com,phone-number:1234567890,country:US}" --plan-data "{usage-type:committed,billing-cycle:Monthly,plan-details:azureportalintegration_privatepreview@TIDhjdtn7tfnxcy,effective-date:2022-08-20}" --environment "{single-sign-on:{aad-domains:['abc']}}"

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

--environment

Properties of the Dynatrace environment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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

--monitoring-status

Status of the monitor.

Accepted values: Disabled, Enabled
--no-wait

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

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

Billing plan information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscription-status

Marketplace subscription status.

Accepted values: Active, Suspended
--tags

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

--user-info

User info. 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 dynatrace monitor delete

Delete a monitor resource.

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

Examples

Delete a monitor

az dynatrace monitor delete -n monitor -g rg -y

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.

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 dynatrace monitor get-sso-detail

Get the SSO configuration details from the partner.

az dynatrace monitor get-sso-detail --monitor-name
                                    --resource-group
                                    [--user-principal]

Examples

Get-sso-detail

az dynatrace monitor get-sso-detail -g rg --monitor-name monitor  --user-principal Alice@microsoft.com

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

Optional Parameters

--user-principal

User principal id of the user.

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 dynatrace monitor get-vm-host-payload

Return the payload that need to be passed in the request body for installing Dynatrace agent on a VM.

az dynatrace monitor get-vm-host-payload --monitor-name
                                         --resource-group

Examples

Get-vm-host-payload

az dynatrace monitor get-vm-host-payload -g rg --monitor-name monitor

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 dynatrace monitor list

List all monitor resource by monitor name in a resource group.

az dynatrace monitor list --resource-group

Examples

List monitor

az dynatrace monitor list -g rg --monitor-name monitor

Required 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 dynatrace monitor list-app-service

Get list of app services with dynatrace PaaS OneAgent enabled.

az dynatrace monitor list-app-service --monitor-name
                                      --resource-group

Examples

List-app-service

az dynatrace monitor list-app-service -g rg --monitor-name monitor

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 dynatrace monitor list-host

List the compute resources currently being monitored by the dynatrace resource.

az dynatrace monitor list-host --monitor-name
                               --resource-group

Examples

List-host

az dynatrace monitor list-host -g rg --monitor-name monitor

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 dynatrace monitor list-linkable-environment

Get all the dynatrace environments that a user can link a azure resource to.

az dynatrace monitor list-linkable-environment --monitor-name
                                               --resource-group
                                               [--region]
                                               [--tenant-id]
                                               [--user-principal]

Examples

List-linkable-environment

az dynatrace monitor list-linkable-environment -g rg --monitor-name monitor --user-principal Alice@microsoft.com --region eastus2euap

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

Optional Parameters

--region

Azure region in which we want to link the environment.

--tenant-id

Tenant Id of the user in which they want to link the environment.

--user-principal

User principal id of the user.

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 dynatrace monitor list-monitored-resource

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

az dynatrace monitor list-monitored-resource --monitor-name
                                             --resource-group

Examples

List-monitored-resource

az dynatrace monitor list-monitored-resource -g rg --monitor-name monitor

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

Show a monitor resource.

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

Examples

Show a monitor

az dynatrace monitor show -g rg -n monitor

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

Update a monitor resource.

az dynatrace monitor update [--ids]
                            [--monitor-name]
                            [--resource-group]
                            [--subscription]
                            [--tags]

Examples

Update monitor

az dynatrace monitor update -g {rg} -n {monitor} --tags {{env:dev}}

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.

--tags

Resource tags. 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 dynatrace monitor wait

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

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

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.