az elastic monitor
Note
This reference is part of the elastic extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az elastic monitor command. Learn more about extensions.
Manage monitoring configurations and resources with Elastic, ensuring optimal observability and performance.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az elastic monitor associate-traffic-filter |
Associate a traffic filter with your Elastic monitor resource to control and manage network traffic. |
Extension | GA |
| az elastic monitor create |
Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic. |
Extension | GA |
| az elastic monitor create-and-associate-ip-filter |
Create and associate an IP filter with your Elastic monitor resource to control and manage network traffic. |
Extension | GA |
| az elastic monitor create-and-associate-pl-filter |
Create and associate a PL filter with your Elastic monitor resource to control and manage network traffic. |
Extension | GA |
| az elastic monitor create-or-update-external-user |
Create or update external user configurations for your Elastic monitor resource, enabling access and management by external users. |
Extension | GA |
| az elastic monitor delete |
Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities. |
Extension | GA |
| az elastic monitor delete-traffic-filter |
Delete an existing traffic filter associated with your Elastic monitor resource, removing its network traffic control capabilities. |
Extension | GA |
| az elastic monitor detach-and-delete-traffic-filter |
Detach and delete an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities. |
Extension | GA |
| az elastic monitor detach-traffic-filter |
Detach an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities. |
Extension | GA |
| az elastic monitor get-billing-info |
Retrieve marketplace and organization billing information mapped to the given Elastic monitor resource. |
Extension | GA |
| az elastic monitor list |
List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup. |
Extension | GA |
| az elastic monitor list-all-traffic-filter |
List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control. |
Extension | GA |
| az elastic monitor list-associated-traffic-filter |
List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control. |
Extension | GA |
| az elastic monitor list-connected-partner-resource |
List all active deployments associated with the marketplace subscription linked to the given Elastic monitor resource. |
Extension | GA |
| az elastic monitor list-deployment-info |
Fetch detailed information about Elastic cloud deployments corresponding to the Elastic monitor resource. |
Extension | GA |
| az elastic monitor list-monitored-resource |
List all resources currently being monitored by the Elastic monitor resource, helping you manage observability. |
Extension | GA |
| az elastic monitor list-resource |
List all resources currently being monitored by the Elastic monitor resource, helping you manage observability. |
Extension | GA |
| az elastic monitor list-upgradable-version |
List all upgradable versions for your Elastic monitor resource, helping you plan and execute upgrades. |
Extension | GA |
| az elastic monitor list-vm-host |
List all VM resources currently being monitored by the Elastic monitor resource, helping you manage observability. |
Extension | GA |
| az elastic monitor monitored-subscription |
Manage subscriptions monitored by the Elastic monitor resource, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor monitored-subscription create |
Create subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring. |
Extension | GA |
| az elastic monitor monitored-subscription delete |
Delete subscriptions being monitored by the Elastic monitor resource, removing their observability and monitoring capabilities. |
Extension | GA |
| az elastic monitor monitored-subscription list |
List all subscriptions currently being monitored by the Elastic monitor resource, helping you manage observability. |
Extension | GA |
| az elastic monitor monitored-subscription show |
Get detailed information about all subscriptions currently being monitored by the Elastic monitor resource. |
Extension | GA |
| az elastic monitor monitored-subscription update |
Update subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring. |
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 OpenAI integration with Elastic, enabling advanced AI-driven observability and monitoring. |
Extension | GA |
| az elastic monitor open-ai-integration create |
Create an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring. |
Extension | GA |
| az elastic monitor open-ai-integration delete |
Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities. |
Extension | GA |
| az elastic monitor open-ai-integration get-statu |
Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor open-ai-integration get-status |
Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor open-ai-integration list |
List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring. |
Extension | GA |
| az elastic monitor open-ai-integration show |
Get detailed information about OpenAI integration rules for a given Elastic monitor resource. |
Extension | GA |
| az elastic monitor open-ai-integration update |
Update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring. |
Extension | GA |
| az elastic monitor show |
Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance. |
Extension | GA |
| az elastic monitor tag-rule |
Manage tag rules with Elastic, enabling fine-grained control over observability based on resource tags. |
Extension | GA |
| az elastic monitor tag-rule create |
Create a tag rule set for a given Elastic monitor resource, enabling fine-grained control over observability based on resource tags. |
Extension | GA |
| az elastic monitor tag-rule delete |
Delete a tag rule set for a given Elastic monitor resource, removing fine-grained control over observability based on resource tags. |
Extension | GA |
| az elastic monitor tag-rule list |
List all tag rules for a given Elastic monitor resource, helping you manage fine-grained control over observability based on resource tags. |
Extension | GA |
| az elastic monitor tag-rule show |
Get detailed information about a tag rule set for a given Elastic monitor resource. |
Extension | GA |
| az elastic monitor tag-rule update |
Update a tag rule set for a given Elastic monitor resource, enabling fine-grained control over observability based on resource tags. |
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 new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic. |
Extension | GA |
| az elastic monitor update-vm-collection |
Update the VM details that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor upgrade |
Upgrade the Elastic monitor resource to a newer version, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor vm-collection-update |
Update the VM details that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance. |
Extension | GA |
| az elastic monitor vm-ingestion-detail |
List detailed information about VM ingestion that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance. |
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 a traffic filter with your Elastic monitor resource to control and manage network traffic.
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
AssociateTrafficFilter_Associate
az elastic monitor associate-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor --ruleset-id 31d91b5afb6f4c2eaaf104c97b1991dd
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Ruleset Id of the filter.
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor create
Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.
az elastic monitor create --monitor-name --name
--resource-group
[--generate-api-key {0, 1, f, false, n, no, t, true, y, yes}]
[--hosting-type {Hosted, Serverless}]
[--identity]
[--kind]
[--location]
[--monitoring-status {Disabled, Enabled}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--plan-details]
[--project-details]
[--saa-s-azure-subscription-status --saas-status]
[--sku]
[--source-campaign-id]
[--source-campaign-name]
[--subscription-state]
[--tags]
[--user-info]
[--version]
Examples
Monitors_Create
az elastic monitor create --resource-group myResourceGroup --monitor-name myMonitor
Required Parameters
Monitor resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Flag to determine if User API Key has to be generated and shared.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Hosted, Serverless |
Identity properties of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
The kind of the Elastic resource - observability, security, search etc.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
The location of the monitor resource.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Flag specifying if the resource monitoring is enabled or disabled.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Plan details of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Project details of the monitor resource IF it belongs to Serverless offer kind. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Status of Azure Subscription where Marketplace SaaS is located.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
SKU of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
A unique identifier associated with the campaign.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Name of the marketing campaign.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
State of the Azure Subscription containing the monitor resource.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The tags of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
User information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Version of elastic of the monitor resource.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor create-and-associate-ip-filter
Create and associate an IP filter with your Elastic monitor resource to control and manage network traffic.
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
createAndAssociateIPFilter_Create
az elastic monitor create-and-associate-ip-filter --resource-group myResourceGroup --monitor-name myMonitor --ips 192.168.131.0, 192.168.132.6/22
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
List of ips.
Monitor resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the traffic filter.
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor create-and-associate-pl-filter
Create and associate a PL filter with your Elastic monitor resource to control and manage network traffic.
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
createAndAssociatePLFilter_Create
az elastic monitor create-and-associate-pl-filter --resource-group myResourceGroup --monitor-name myMonitor --private-endpoint-guid fdb54d3b-e85e-4d08-8958-0d2f7g523df9 --private-endpoint-name myPrivateEndpoint
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the traffic filter.
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Guid of the private endpoint.
Name of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor create-or-update-external-user
Create or update external user configurations for your Elastic monitor resource, enabling access and management by external users.
az elastic monitor create-or-update-external-user [--email-id]
[--full-name]
[--ids]
[--monitor-name]
[--password]
[--resource-group]
[--roles]
[--subscription]
[--user-name]
Examples
ExternalUser_CreateOrUpdate
az elastic monitor create-or-update-external-user --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Email id of the user to be created or updated.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Full name of the user to be created or updated.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Password of the user to be created or updated.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Roles to be assigned for created or updated user Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
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 |
Username of the user to be created or updated.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor delete
Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities.
az elastic monitor delete [--ids]
[--monitor-name --name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Monitors_Delete
az elastic monitor delete --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor delete-traffic-filter
Delete an existing traffic filter associated with your Elastic monitor resource, removing its network traffic control capabilities.
az elastic monitor delete-traffic-filter [--ids]
[--monitor-name]
[--resource-group]
[--ruleset-id]
[--subscription]
Examples
TrafficFilters_Delete
az elastic monitor delete-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor --ruleset-id 31d91b5afb6f4c2eaaf104c97b1991dd
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Ruleset Id of the filter.
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor detach-and-delete-traffic-filter
Detach and delete an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities.
az elastic monitor detach-and-delete-traffic-filter [--ids]
[--monitor-name]
[--resource-group]
[--ruleset-id]
[--subscription]
Examples
DetachAndDeleteTrafficFilter_Delete
az elastic monitor detach-and-delete-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor --ruleset-id 31d91b5afb6f4c2eaaf104c97b1991dd
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Ruleset Id of the filter.
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor detach-traffic-filter
Detach an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities.
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
DetachTrafficFilter_Update
az elastic monitor detach-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor --ruleset-id 31d91b5afb6f4c2eaaf104c97b1991dd
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Ruleset Id of the filter.
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor get-billing-info
Retrieve marketplace and organization billing information mapped to the given Elastic monitor resource.
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list
List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup.
az elastic monitor list [--max-items]
[--next-token]
[--resource-group]
Examples
Monitors_List
az elastic monitor list
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-all-traffic-filter
List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control.
az elastic monitor list-all-traffic-filter [--ids]
[--monitor-name]
[--resource-group]
[--subscription]
Examples
AllTrafficFilters_list
az elastic monitor list-all-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-associated-traffic-filter
List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control.
az elastic monitor list-associated-traffic-filter [--ids]
[--monitor-name]
[--resource-group]
[--subscription]
Examples
listAssociatedTrafficFilters_list
az elastic monitor list-associated-traffic-filter --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-connected-partner-resource
List all active deployments associated with the marketplace subscription linked to the given Elastic monitor resource.
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 resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-deployment-info
Fetch detailed information about Elastic cloud deployments corresponding to the Elastic monitor resource.
az elastic monitor list-deployment-info [--ids]
[--monitor-name]
[--resource-group]
[--subscription]
Examples
DeploymentInfo_List
az elastic monitor list-deployment-info --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-monitored-resource
List all resources currently being monitored by the Elastic monitor resource, helping you manage observability.
az elastic monitor list-monitored-resource --monitor-name
--resource-group
[--max-items]
[--next-token]
Examples
MonitoredResources_List
az elastic monitor list-monitored-resource --resource-group myResourceGroup --monitor-name myMonitor
Required Parameters
Monitor resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-resource
List all resources currently being monitored by the Elastic monitor resource, helping you manage observability.
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 resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-upgradable-version
List all upgradable versions for your Elastic monitor resource, helping you plan and execute upgrades.
az elastic monitor list-upgradable-version [--ids]
[--monitor-name]
[--resource-group]
[--subscription]
Examples
UpgradableVersions_Details
az elastic monitor list-upgradable-version --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor list-vm-host
List all VM resources currently being monitored by the Elastic monitor resource, helping you manage observability.
az elastic monitor list-vm-host --monitor-name
--resource-group
[--max-items]
[--next-token]
Examples
VMHost_List
az elastic monitor list-vm-host --resource-group myResourceGroup --monitor-name myMonitor
Required Parameters
Monitor resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor show
Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance.
az elastic monitor show [--ids]
[--monitor-name --name]
[--resource-group]
[--subscription]
Examples
Monitors_Get
az elastic monitor show --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor update
Update a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.
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}]
[--hosting-type {Hosted, Serverless}]
[--identity]
[--ids]
[--kind]
[--monitor-name --name]
[--monitoring-status {Disabled, Enabled}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--plan-details]
[--project-details]
[--remove]
[--resource-group]
[--saa-s-azure-subscription-status --saas-status]
[--set]
[--sku]
[--source-campaign-id]
[--source-campaign-name]
[--subscription]
[--subscription-state]
[--tags]
[--version]
Examples
Monitors_Create
az elastic monitor update --resource-group myResourceGroup --monitor-name myMonitor
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 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 |
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 |
Flag to determine if User API Key has to be generated and shared.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Hosted, Serverless |
Identity properties of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
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 |
The kind of the Elastic resource - observability, security, search etc.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Monitor resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Flag specifying if the resource monitoring is enabled or disabled.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Plan details of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Project details of the monitor resource IF it belongs to Serverless offer kind. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Status of Azure Subscription where Marketplace SaaS is located.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
SKU of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
A unique identifier associated with the campaign.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Name of the marketing campaign.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
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 |
State of the Azure Subscription containing the monitor resource.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The tags of the monitor resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Version of elastic of the monitor resource.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor update-vm-collection
Update the VM details that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Operation to be performed for given VM.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
| Accepted values: | Add, Delete |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
ARM id of the VM resource.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor upgrade
Upgrade the Elastic monitor resource to a newer version, ensuring optimal observability and performance.
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 --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Version to which the elastic monitor should be upgraded to.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor vm-collection-update
Update the VM details that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
az elastic monitor vm-collection-update [--ids]
[--monitor-name]
[--operation-name {Add, Delete}]
[--resource-group]
[--subscription]
[--vm-resource-id]
Examples
VMCollection_Update
az elastic monitor vm-collection-update --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Operation to be performed for given VM.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
| Accepted values: | Add, Delete |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
ARM id of the VM resource.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az elastic monitor vm-ingestion-detail
List detailed information about VM ingestion that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
az elastic monitor vm-ingestion-detail [--ids]
[--monitor-name]
[--resource-group]
[--subscription]
Examples
VMIngestion_Details
az elastic monitor vm-ingestion-detail --resource-group myResourceGroup --monitor-name myMonitor
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
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 --name]
[--resource-group]
[--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.
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Monitor resource name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |