Share via


az elastic

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 command. Learn more about extensions.

Manage Microsoft Elastic.

Commands

Name Description Type Status
az elastic elastic-version

Retrieve a list of all available Elastic versions for a specified region, helping you choose the best version for your deployment.

Extension GA
az elastic elastic-version list

List a list of available versions for a region.

Extension GA
az elastic get

Manage and retrieve detailed information about your Elastic resources, including configurations and status.

Extension GA
az elastic get-organization-api-key

Fetch the User API Key from the internal database, if it was generated and stored during the creation of the Elasticsearch Organization.

Extension GA
az elastic get elastic

Retrieve detailed information about your Elastic resources, including configurations and status.

Extension GA
az elastic get elastic organization-to-azure

Manage and retrieve information about the Elastic organization linked to your Azure subscription.

Extension GA
az elastic get elastic organization-to-azure subscription

Get detailed information about the Elastic Organization linked to your Azure subscription for the logged-in user.

Extension GA
az elastic get elastic organization-to-azure subscription mapping

Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user.

Extension GA
az elastic monitor

Manage monitoring configurations and resources with Elastic, ensuring optimal observability and performance.

Extension GA
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 resource group or across the entire 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-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, ensuring optimal observability and performance.

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 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, ensuring optimal 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, ensuring 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 an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance.

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-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 get-organization-api-key

Fetch the User API Key from the internal database, if it was generated and stored during the creation of the Elasticsearch Organization.

az elastic get-organization-api-key [--email-id]

Examples

Get organization api key

az elastic get-organization-api-key --email-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.

--email-id

The User email Id.

Property Value
Parameter group: Body Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False