Share via

az elastic monitor

  • Reference

Note

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

Manage monitor with elastic.

Commands

Name Description Type Status
az elastic monitor associate-traffic-filter

Associate traffic filter.

 Extension GA
az elastic monitor create

Create a monitor resource.

 Extension GA
az elastic monitor create-and-associate-ip-filter

Create and associate ip filter.

 Extension GA
az elastic monitor create-and-associate-pl-filter

Create and associate pl filter.

 Extension GA
az elastic monitor create-or-update-external-user

Create or update external user.

 Extension GA
az elastic monitor delete

Delete a monitor resource.

 Extension GA
az elastic monitor delete-traffic-filter

Delete traffic filter.

 Extension GA
az elastic monitor detach-and-delete-traffic-filter

Detach and delete traffic filter.

 Extension GA
az elastic monitor detach-traffic-filter

Detach traffic filter.

 Extension GA
az elastic monitor get-billing-info

Get marketplace and organization info mapped to the given monitor.

 Extension GA
az elastic monitor list

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

 Extension GA
az elastic monitor list-all-traffic-filter

List all traffic filter.

 Extension GA
az elastic monitor list-associated-traffic-filter

List associated traffic filter.

 Extension GA
az elastic monitor list-connected-partner-resource

List of all active deployments that are associated with the marketplace subscription linked to the given monitor.

 Extension GA
az elastic monitor list-deployment-info

Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.

 Extension GA
az elastic monitor list-resource

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

 Extension GA
az elastic monitor list-upgradable-version

List upgradable version.

 Extension GA
az elastic monitor list-vm-host

List the vm resources currently being monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor monitored-subscription

Manage monitored subscription with elastic.

 Extension GA
az elastic monitor monitored-subscription create

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

 Extension GA
az elastic monitor monitored-subscription delete

Delete the subscriptions that are being monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor monitored-subscription list

List all the subscriptions currently being monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor monitored-subscription show

Get all the subscriptions currently being monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor monitored-subscription update

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

 Extension GA
az elastic monitor monitored-subscription wait

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

 Extension GA
az elastic monitor open-ai-integration

Manage open-ai Integration with elastic.

 Extension GA
az elastic monitor open-ai-integration create

Create a OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration delete

Delete OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration get-statu

Get OpenAI integration status for a given integration.

 Extension GA
az elastic monitor open-ai-integration list

List OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration show

Get OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration update

Update a OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor show

Get the properties of a specific monitor resource.

 Extension GA
az elastic monitor tag-rule

Manage tag rule with elastic.

 Extension GA
az elastic monitor tag-rule create

Create a tag rule set for a given monitor resource.

 Extension GA
az elastic monitor tag-rule delete

Delete a tag rule set for a given monitor resource.

 Extension GA
az elastic monitor tag-rule list

List the tag rules for a given monitor resource.

 Extension GA
az elastic monitor tag-rule show

Get a tag rule set for a given monitor resource.

 Extension GA
az elastic monitor tag-rule update

Update a tag rule set for a given monitor resource.

 Extension GA
az elastic monitor tag-rule wait

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

 Extension GA
az elastic monitor update

Update a monitor resource.

 Extension GA
az elastic monitor update-vm-collection

Update the vm details that will be monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor upgrade

Upgrade elastic monitor.

 Extension GA
az elastic monitor vm-ingestion-detail

List the vm ingestion details that will be monitored by the Elastic monitor resource.

 Extension GA
az elastic monitor wait

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

 Extension GA

az elastic monitor associate-traffic-filter

Associate traffic filter.

az elastic monitor associate-traffic-filter [--ids]
                                            [--monitor-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--ruleset-id]
                                            [--subscription]

Examples

Monitor associate traffic filter

az elastic monitor associate-traffic-filter --monitor-name name -g rg --ruleset-id

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.

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

--ruleset-id

Ruleset Id of the filter.

--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 elastic monitor create

Create a monitor resource.

az elastic monitor create --monitor-name
                          --resource-group
                          [--generate-api-key {0, 1, f, false, n, no, t, true, y, yes}]
                          [--location]
                          [--monitoring-status {Disabled, Enabled}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--plan-details]
                          [--saa-s-azure-subscription-status]
                          [--sku]
                          [--source-campaign-id]
                          [--source-campaign-name]
                          [--subscription-state]
                          [--tags]
                          [--user-info]
                          [--version]

Examples

Create monitor

az elastic monitor create -n monitor-name -g rg --user-info "{firstName:Alice,lastName:bob,companyName:Micosoft,emailAddress:alice@microsoft.com}" --sku "{name:ess-consumption-2024_Monthly}"

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

--generate-api-key

Flag to determine if User API Key has to be generated and shared.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

The location of the monitor resource.

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

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

Plan details of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--saa-s-azure-subscription-status -s

Status of Azure Subscription where Marketplace SaaS is located.

--sku

SKU of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--source-campaign-id

A unique identifier associated with the campaign.

--source-campaign-name

Name of the marketing campaign.

--subscription-state

State of the Azure Subscription containing the monitor resource.

--tags

The tags of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-info

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

--version

Version of elastic of the monitor resource.

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 elastic monitor create-and-associate-ip-filter

Create and associate ip filter.

az elastic monitor create-and-associate-ip-filter [--ids]
                                                  [--ips]
                                                  [--monitor-name]
                                                  [--name]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Create and associate ip filter

az elastic monitor create-and-associate-ip-filter --monitor-name name -g rg --name name --ips  192.168.131.0, 192.168.132.6/22

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.

--ips

List of ips.

--monitor-name

Monitor resource name.

--name

Name of the traffic filter.

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

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 elastic monitor create-and-associate-pl-filter

Create and associate pl filter.

az elastic monitor create-and-associate-pl-filter [--ids]
                                                  [--monitor-name]
                                                  [--name]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--private-endpoint-guid]
                                                  [--private-endpoint-name]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Create and associate pl filter

az elastic monitor create-and-associate-pl-filter --monitor-name monitor -g rg --name 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

Monitor resource name.

--name

Name of the traffic filter.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-endpoint-guid

Guid of the private endpoint.

--private-endpoint-name

Name of the private endpoint.

--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 elastic monitor create-or-update-external-user

Create or update external user.

az elastic monitor create-or-update-external-user [--email-id]
                                                  [--full-name]
                                                  [--ids]
                                                  [--monitor-name]
                                                  [--password]
                                                  [--resource-group]
                                                  [--roles]
                                                  [--subscription]
                                                  [--user-name]

Examples

Create or update external user

az monitor create-or-update-external-user --monitor-name {monitor} -g {rg} --user-name newuser --full-name fullname --password password --email-id email@outlook.com --roles [admin,other_role]

Optional Parameters

--email-id

Email id of the user to be created or updated.

--full-name

Full name of the user to be created or updated.

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

--password

Password of the user to be created or updated.

--resource-group -g

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

--roles

Roles to be assigned for created or updated user Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscription

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

--user-name

Username of the user to be created or updated.

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

Delete a monitor resource.

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

Examples

Delete monitor

az elastic monitor delete -n monitor -g rg

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 elastic monitor delete-traffic-filter

Delete traffic filter.

az elastic monitor delete-traffic-filter [--ids]
                                         [--monitor-name]
                                         [--resource-group]
                                         [--ruleset-id]
                                         [--subscription]

Examples

Delete traffic filter

az elastic monitor delete-traffic-filter --monitor-name name -g rg --ruleset-id id

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.

--resource-group -g

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

--ruleset-id

Ruleset Id of the filter.

--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 elastic monitor detach-and-delete-traffic-filter

Detach and delete traffic filter.

az elastic monitor detach-and-delete-traffic-filter [--ids]
                                                    [--monitor-name]
                                                    [--resource-group]
                                                    [--ruleset-id]
                                                    [--subscription]

Examples

Detach and delete traffic filter

az elastic monitor detach-and-delete-traffic-filter --monitor-name name -g rg --ruleset-id id

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.

--resource-group -g

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

--ruleset-id

Ruleset Id of the filter.

--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 elastic monitor detach-traffic-filter

Detach traffic filter.

az elastic monitor detach-traffic-filter [--ids]
                                         [--monitor-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--ruleset-id]
                                         [--subscription]

Examples

Detach traffic filter

az elastic monitor detach-traffic-filter --monitor-name name -g rg --ruleset-id

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.

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

--ruleset-id

Ruleset Id of the filter.

--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 elastic monitor get-billing-info

Get marketplace and organization info mapped to the given monitor.

az elastic monitor get-billing-info [--ids]
                                    [--monitor-name]
                                    [--resource-group]
                                    [--subscription]

Examples

BillingInfo_Get

az elastic monitor get-billing-info --resource-group myResourceGroup --monitor-name myMonitor

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.

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

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

az elastic monitor list [--max-items]
                        [--next-token]
                        [--resource-group]

Examples

List all monitors by resource group

az elastic monitor list -g rg

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.

--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 elastic monitor list-all-traffic-filter

List all traffic filter.

az elastic monitor list-all-traffic-filter [--ids]
                                           [--monitor-name]
                                           [--resource-group]
                                           [--subscription]

Examples

List all traffic filter

az elastic monitor list-all-traffic-filter --monitor-name name -g rg

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.

--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 elastic monitor list-associated-traffic-filter

List associated traffic filter.

az elastic monitor list-associated-traffic-filter [--ids]
                                                  [--monitor-name]
                                                  [--resource-group]
                                                  [--subscription]

Examples

List associated traffic filter

az elastic monitor list-associated-traffic-filter --monitor-name name -g rg

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.

--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 elastic monitor list-connected-partner-resource

List of all active deployments that are associated with the marketplace subscription linked to the given monitor.

az elastic monitor list-connected-partner-resource --monitor-name
                                                   --resource-group
                                                   [--max-items]
                                                   [--next-token]

Examples

ConnectedPartnerResources_List

az elastic monitor list-connected-partner-resource --resource-group myResourceGroup --monitor-name myMonitor

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

--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 elastic monitor list-deployment-info

Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.

az elastic monitor list-deployment-info [--ids]
                                        [--monitor-name]
                                        [--resource-group]
                                        [--subscription]

Examples

List deployment info

az elastic monitor list-deployment-info --monitor-name name -g rg

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.

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

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

az elastic monitor list-resource --monitor-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Examples

List resource

az elastic monitor list-resource --monitor-name -g rg

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

--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 elastic monitor list-upgradable-version

List upgradable version.

az elastic monitor list-upgradable-version [--ids]
                                           [--monitor-name]
                                           [--resource-group]
                                           [--subscription]

Examples

List upgradable version

az elastic monitor list-upgradable-version --monitor-name name -g rg

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.

--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 elastic monitor list-vm-host

List the vm resources currently being monitored by the Elastic monitor resource.

az elastic monitor list-vm-host --monitor-name
                                --resource-group
                                [--max-items]
                                [--next-token]

Examples

List vm host

az elastic monitor list-vm-host --monitor-name name -g rg

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

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

Get the properties of a specific monitor resource.

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

Examples

Show monitor

az elastic monitor show -n name -g rg

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

Update a monitor resource.

az elastic monitor update [--add]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--generate-api-key {0, 1, f, false, n, no, t, true, y, yes}]
                          [--identity]
                          [--ids]
                          [--monitor-name]
                          [--monitoring-status {Disabled, Enabled}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--plan-details]
                          [--remove]
                          [--resource-group]
                          [--saa-s-azure-subscription-status]
                          [--set]
                          [--sku]
                          [--source-campaign-id]
                          [--source-campaign-name]
                          [--subscription]
                          [--subscription-state]
                          [--tags]
                          [--version]

Examples

Update monitor

az elastic monitor update -n monitor -g rg --tags "{tag:test,tag1:test1}"

Optional Parameters

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

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--generate-api-key

Flag to determine if User API Key has to be generated and shared.

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

Identity properties of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Plan details of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--saa-s-azure-subscription-status -s

Status of Azure Subscription where Marketplace SaaS is located.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--sku

SKU of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--source-campaign-id

A unique identifier associated with the campaign.

--source-campaign-name

Name of the marketing campaign.

--subscription

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

--subscription-state

State of the Azure Subscription containing the monitor resource.

--tags

The tags of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

Version of elastic of the monitor resource.

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 elastic monitor update-vm-collection

Update the vm details that will be monitored by the Elastic monitor resource.

az elastic monitor update-vm-collection [--ids]
                                        [--monitor-name]
                                        [--operation-name {Add, Delete}]
                                        [--resource-group]
                                        [--subscription]
                                        [--vm-resource-id]

Examples

Update vm collection

az elastic monitor update-vm-collection --monitor-name monitor1 -g rg --operation-name Add --vi-resource-id id

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.

--operation-name

Operation to be performed for given VM.

Accepted values: Add, Delete
--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.

--vm-resource-id

ARM id of the VM resource.

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 elastic monitor upgrade

Upgrade elastic monitor.

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

Examples

Monitor upgrade

az elastic monitor upgrade -g rg --monitor-name monitor --version 8.0.0

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.

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

--version

Version to which the elastic monitor should be upgraded to.

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 elastic monitor vm-ingestion-detail

List the vm ingestion details that will be monitored by the Elastic monitor resource.

az elastic monitor vm-ingestion-detail [--ids]
                                       [--monitor-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Vm ingestion detail

az elastic monitor vm-ingestion-detail --monitor-name name -g rg

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.

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

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

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