az new-relic monitor monitored-subscription

Note

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

Manage subscriptions monitored by the New Relic monitor resource, ensuring optimal observability and performance.

Commands

Name	Description	Type	Status
az new-relic monitor monitored-subscription create	Create subscriptions to be monitored by the New Relic monitor resource, enabling observability and monitoring.	Extension	GA
az new-relic monitor monitored-subscription delete	Delete subscriptions being monitored by the New Relic monitor resource, removing their observability and monitoring capabilities.	Extension	GA
az new-relic monitor monitored-subscription show	Get detailed information about all subscriptions currently being monitored by the New Relic monitor resource.	Extension	GA
az new-relic monitor monitored-subscription update	Update subscriptions to be monitored by the New Relic monitor resource, ensuring optimal observability and performance.	Extension	GA
az new-relic monitor monitored-subscription wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az new-relic monitor monitored-subscription create

Create subscriptions to be monitored by the New Relic monitor resource, enabling observability and monitoring.

az new-relic monitor monitored-subscription create --configuration-name {default}
                                                   --g --resource-group
                                                   --monitor-name
                                                   [--monitored-subscription-list --subscriptions]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--patch-operation {Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete}]

Examples

Create the subscriptions that should be monitored by the NewRelic monitor resource.

Please run below commands in the mentioned order
1) az new-relic monitor monitored-subscription create --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default --patch-operation AddBegin --subscriptions "[{status:'InProgress',subscription-id:'subscription-id'}]"
2) az new-relic monitor monitored-subscription create --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default --patch-operation AddComplete --subscriptions "[{status:'Active',subscription-id:'subscription-id'}]"

Required Parameters

--configuration-name

The configuration name. Only 'default' value is supported.

Property	Value
Accepted values:	default

--g --resource-group

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

--monitor-name

Name of the Monitoring resource.

Optional Parameters

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

--monitored-subscription-list --subscriptions -n

List of subscriptions and the state of the monitoring. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--patch-operation

The operation for the patch on the resource.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete

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 new-relic monitor monitored-subscription delete

Delete subscriptions being monitored by the New Relic monitor resource, removing their observability and monitoring capabilities.

az new-relic monitor monitored-subscription delete [--configuration-name {default}]
                                                   [--g --resource-group]
                                                   [--ids]
                                                   [--monitor-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--subscription]

Examples

Delete the subscriptions that are being monitored by the NewRelic monitor resource

az new-relic monitor monitored-subscription delete --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default

Optional Parameters

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

--configuration-name

The configuration name. Only 'default' value is supported.

Property	Value
Parameter group:	Resource Id Arguments
Default value:	default
Accepted values:	default

--g --resource-group

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

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

--monitor-name

Name of the Monitoring resource.

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

--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 new-relic monitor monitored-subscription show

Get detailed information about all subscriptions currently being monitored by the New Relic monitor resource.

az new-relic monitor monitored-subscription show [--configuration-name {default}]
                                                 [--g --resource-group]
                                                 [--ids]
                                                 [--monitor-name]
                                                 [--subscription]

Examples

List the subscriptions currently being monitored by the NewRelic monitor resource.

az new-relic monitor monitored-subscription show --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default

Optional Parameters

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

--configuration-name

The configuration name. Only 'default' value is supported.

Property	Value
Parameter group:	Resource Id Arguments
Default value:	default
Accepted values:	default

--g --resource-group

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Name of the Monitoring resource.

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 new-relic monitor monitored-subscription update

Update subscriptions to be monitored by the New Relic monitor resource, ensuring optimal observability and performance.

az new-relic monitor monitored-subscription update [--add]
                                                   [--configuration-name {default}]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--g --resource-group]
                                                   [--ids]
                                                   [--monitor-name]
                                                   [--monitored-subscription-list --subscriptions]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--patch-operation {Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete}]
                                                   [--remove]
                                                   [--set]
                                                   [--subscription]

Examples

Update the subscriptions that should be monitored by the NewRelic monitor resource.

Please run below commands in the mentioned order
1) az new-relic monitor monitored-subscription update --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default --patch-operation AddBegin --subscriptions "[{status:'InProgress',subscription-id:'subscription-id'}]"
2) az new-relic monitor monitored-subscription update --resource-group MyResourceGroup --monitor-name MyNewRelicMonitor --configuration-name default --patch-operation AddComplete --subscriptions "[{status:'Active',subscription-id:'subscription-id'}]"

Optional Parameters

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

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

--configuration-name

The configuration name. Only 'default' value is supported.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	default

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

--g --resource-group

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Name of the Monitoring resource.

Property	Value
Parameter group:	Resource Id Arguments

--monitored-subscription-list --subscriptions -n

List of subscriptions and the state of the monitoring. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--patch-operation

The operation for the patch on the resource.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Active, AddBegin, AddComplete, DeleteBegin, DeleteComplete

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

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

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 new-relic monitor monitored-subscription wait

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

az new-relic monitor monitored-subscription wait [--configuration-name {default}]
                                                 [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--g --resource-group]
                                                 [--ids]
                                                 [--interval]
                                                 [--monitor-name]
                                                 [--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.

--configuration-name

The configuration name. Only 'default' value is supported.

Property	Value
Parameter group:	Resource Id Arguments
Default value:	default
Accepted values:	default

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

--g --resource-group

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

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--monitor-name

Name of the Monitoring resource.

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

Feedback

Was this page helpful?

Share via

az new-relic monitor monitored-subscription

Commands

az new-relic monitor monitored-subscription create

Examples

Required Parameters

Optional Parameters

az new-relic monitor monitored-subscription delete

Examples

Optional Parameters

az new-relic monitor monitored-subscription show

Examples

Optional Parameters

az new-relic monitor monitored-subscription update

Examples

Optional Parameters

az new-relic monitor monitored-subscription wait

Optional Parameters

Feedback