Share via

az elastic monitor open-ai-integration

  • Reference

Note

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

Manage open-ai Integration with elastic.

Commands

Name Description Type Status
az elastic monitor open-ai-integration create

Create a OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration delete

Delete OpenAI integration rule for a given monitor resource.

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

Get OpenAI integration status for a given integration.

 Extension GA
az elastic monitor open-ai-integration list

List OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration show

Get OpenAI integration rule for a given monitor resource.

 Extension GA
az elastic monitor open-ai-integration update

Update a OpenAI integration rule for a given monitor resource.

 Extension GA

az elastic monitor open-ai-integration create

Create a OpenAI integration rule for a given monitor resource.

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

--key

Value of API key for Open AI resource.

--open-ai-connector-id

The connector id of Open AI resource.

--open-ai-resource-endpoint -e

The API endpoint for Open AI resource.

--open-ai-resource-id

The resource name of Open AI resource.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az elastic monitor open-ai-integration delete

Delete OpenAI integration rule for a given monitor resource.

az elastic monitor open-ai-integration delete [--ids]
                                              [--integration-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

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az elastic monitor open-ai-integration get-statu

Get OpenAI integration status for a given integration.

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

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

--integration-name

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az elastic monitor open-ai-integration list

List OpenAI integration rule for a given monitor resource.

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az elastic monitor open-ai-integration show

Get OpenAI integration rule for a given monitor resource.

az elastic monitor open-ai-integration show [--ids]
                                            [--integration-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

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

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az elastic monitor open-ai-integration update

Update a OpenAI integration rule for a given monitor resource.

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

Optional Parameters

--add

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--integration-name --name -n

OpenAI Integration name.

--key

Value of API key for Open AI resource.

--monitor-name

Monitor resource name.

--open-ai-connector-id

The connector id of Open AI resource.

--open-ai-resource-endpoint -e

The API endpoint for Open AI resource.

--open-ai-resource-id

The resource name of Open AI resource.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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