az elastic monitor open-ai-integration

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

Manage OpenAI integration with Elastic, enabling advanced AI-driven observability and monitoring.

Commands

Name	Description	Type	Status
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 open-ai-integration create

Create an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring.

az elastic monitor open-ai-integration create --integration-name --name
                                              --monitor-name
                                              --resource-group
                                              [--key]
                                              [--open-ai-connector-id]
                                              [--open-ai-resource-endpoint]
                                              [--open-ai-resource-id]

Examples

OpenAI_CreateOrUpdate

az elastic monitor open-ai-integration create --resource-group myResourceGroup --monitor-name myMonitor --integration-name default

Required Parameters

--integration-name --name -n

OpenAI Integration name.

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

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

--key

Value of API key for Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--open-ai-connector-id

The connector id of Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--open-ai-resource-endpoint -e

The API endpoint for Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--open-ai-resource-id

The resource name of Open AI resource.

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

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.

az elastic monitor open-ai-integration delete [--ids]
                                              [--integration-name --name]
                                              [--monitor-name]
                                              [--resource-group]
                                              [--subscription]
                                              [--yes]

Examples

OpenAI_Delete

az elastic monitor open-ai-integration delete --resource-group myResourceGroup --monitor-name myMonitor --integration-name default

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--integration-name --name -n

OpenAI Integration name.

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--verbose

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

Property	Value
Default value:	False

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.

az elastic monitor open-ai-integration get-statu [--ids]
                                                 [--integration-name]
                                                 [--monitor-name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

OpenAI_GetStatus

az elastic monitor open-ai-integration get-statu --resource-group myResourceGroup --monitor-name myMonitor --integration-name default

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--integration-name

OpenAI Integration name.

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--verbose

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

Property	Value
Default value:	False

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

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

Examples

OpenAI_List

az elastic monitor open-ai-integration list --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

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--subscription

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

--verbose

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

Property	Value
Default value:	False

az elastic monitor open-ai-integration show

Get detailed information about OpenAI integration rules for a given Elastic monitor resource.

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

Examples

OpenAI_Get

az elastic monitor open-ai-integration show --resource-group myResourceGroup --monitor-name myMonitor --integration-name default

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--integration-name --name -n

OpenAI Integration name.

Property	Value
Parameter group:	Resource Id Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--verbose

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

Property	Value
Default value:	False

az elastic monitor open-ai-integration update

Update an OpenAI integration rule for a given Elastic monitor resource, ensuring optimal AI-driven observability and monitoring.

az elastic monitor open-ai-integration update [--add]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ids]
                                              [--integration-name --name]
                                              [--key]
                                              [--monitor-name]
                                              [--open-ai-connector-id]
                                              [--open-ai-resource-endpoint]
                                              [--open-ai-resource-id]
                                              [--remove]
                                              [--resource-group]
                                              [--set]
                                              [--subscription]

Examples

OpenAI_Update

az elastic monitor open-ai-integration update --resource-group myResourceGroup --monitor-name myMonitor --integration-name default

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--integration-name --name -n

OpenAI Integration name.

Property	Value
Parameter group:	Resource Id Arguments

--key

Value of API key for Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--monitor-name

Monitor resource name.

Property	Value
Parameter group:	Resource Id Arguments

--open-ai-connector-id

The connector id of Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--open-ai-resource-endpoint -e

The API endpoint for Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--open-ai-resource-id

The resource name of Open AI resource.

Property	Value
Parameter group:	Properties Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

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

--verbose

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

Property	Value
Default value:	False