Share via

az workloads monitor provider-instance

  • Preview
  • Reference

Note

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

Command group 'az workloads monitor' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage monitor provider instance.

Commands

Name Description Type Status
az workloads monitor provider-instance create

Create a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance delete

Delete a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance list

List a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances.

 Extension Preview
az workloads monitor provider-instance show

Show properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

 Extension Preview
az workloads monitor provider-instance wait

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

 Extension Preview

az workloads monitor provider-instance create

Preview

Command group 'az workloads monitor provider-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

az workloads monitor provider-instance create --monitor-name
                                              --name
                                              --resource-group
                                              [--identity]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--provider-settings]

Examples

Create a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

az workloads monitor provider-instance create --monitor-name <monitor-name> -n <provider-instamce-name> -g <RG-NAME> --provider-settings <provider-settings>

Required Parameters

--monitor-name

Name of the SAP monitor resource.

--name --provider-instance-name -n

Name of the provider instance.

--resource-group -g

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

Optional Parameters

--identity

[currently not in use] Managed service identity(user assigned identities) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--provider-settings

Defines the provider specific properties. 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 workloads monitor provider-instance delete

Preview

Command group 'az workloads monitor provider-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

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

Examples

Delete a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

az workloads monitor provider-instance delete --monitor-name <monitor-name> -n <provider-instance-name> -g <RG-NAME>

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 of the SAP monitor resource.

--name --provider-instance-name -n

Name of the provider instance.

--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 workloads monitor provider-instance list

Preview

Command group 'az workloads monitor provider-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances.

az workloads monitor provider-instance list --monitor-name
                                            --resource-group
                                            [--max-items]
                                            [--next-token]

Examples

Get a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances.

az workloads monitor provider-instance list --monitor-name <monitor-name> -g <RG-NAME>

Required Parameters

--monitor-name

Name of the SAP monitor resource.

--resource-group -g

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

Optional Parameters

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

--next-token

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

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 workloads monitor provider-instance show

Preview

Command group 'az workloads monitor provider-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

az workloads monitor provider-instance show [--ids]
                                            [--monitor-name]
                                            [--name]
                                            [--resource-group]
                                            [--subscription]

Examples

Show properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name.

az workloads monitor provider-instance show --monitor-name <monitor-name> -n <provider-instance-name> -g <RG-NAME>

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 of the SAP monitor resource.

--name --provider-instance-name -n

Name of the provider instance.

--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 workloads monitor provider-instance wait

Preview

Command group 'az workloads monitor provider-instance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az workloads monitor provider-instance wait [--created]
                                            [--custom]
                                            [--deleted]
                                            [--exists]
                                            [--ids]
                                            [--interval]
                                            [--monitor-name]
                                            [--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 of the SAP monitor resource.

--name --provider-instance-name -n

Name of the provider instance.

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