open_ai

Creates, updates, deletes, gets or lists an open_ai resource.

Overview

Name	open_ai
Type	Resource
Id	azure_isv.elastic.open_ai

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The id of the integration.
name	string	Name of the integration.
key	string	Value of API key for Open AI resource.
lastRefreshAt	string (date-time)	Last Update Timestamp for key updation.
openAIConnectorId	string	The connector id of Open AI resource.
openAIResourceEndpoint	string	The API endpoint for Open AI resource.
openAIResourceId	string	The resource name of Open AI resource.
type	string	The type of the integration.

list

Name	Datatype	Description
id	string	The id of the integration.
name	string	Name of the integration.
key	string	Value of API key for Open AI resource.
lastRefreshAt	string (date-time)	Last Update Timestamp for key updation.
openAIConnectorId	string	The connector id of Open AI resource.
openAIResourceEndpoint	string	The API endpoint for Open AI resource.
openAIResourceId	string	The resource name of Open AI resource.
type	string	The type of the integration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, monitor_name, integration_name, subscription_id		Get detailed information about OpenAI integration rules for a given Elastic monitor resource. Get detailed information about OpenAI integration rules for a given Elastic monitor resource.
list	select	resource_group_name, monitor_name, subscription_id		List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring. List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring.
create_or_update	insert	resource_group_name, monitor_name, integration_name, subscription_id		Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring. Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring.
create_or_update	replace	resource_group_name, monitor_name, integration_name, subscription_id		Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring. Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring.
delete	delete	resource_group_name, monitor_name, integration_name, subscription_id		Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities. Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities.
get_status	exec	resource_group_name, monitor_name, integration_name, subscription_id		Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance. Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
integration_name	string	OpenAI Integration name. Required.
monitor_name	string	Monitor resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
key,
lastRefreshAt,
openAIConnectorId,
openAIResourceEndpoint,
openAIResourceId,
type
FROM azure_isv.elastic.open_ai
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND integration_name = '{{ integration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring. List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring.

SELECT
id,
name,
key,
lastRefreshAt,
openAIConnectorId,
openAIResourceEndpoint,
openAIResourceId,
type
FROM azure_isv.elastic.open_ai
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_isv.elastic.open_ai (
properties,
resource_group_name,
monitor_name,
integration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ integration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: open_ai
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the open_ai resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the open_ai resource.
  - name: integration_name
    value: "{{ integration_name }}"
    description: Required parameter for the open_ai resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the open_ai resource.
  - name: properties
    description: |
      Open AI Integration details.
    value:
      openAIResourceId: "{{ openAIResourceId }}"
      openAIResourceEndpoint: "{{ openAIResourceEndpoint }}"
      openAIConnectorId: "{{ openAIConnectorId }}"
      key: "{{ key }}"
      lastRefreshAt: "{{ lastRefreshAt }}"

REPLACE examples

create_or_update

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

REPLACE azure_isv.elastic.open_ai
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND integration_name = '{{ integration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities. Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities.

DELETE FROM azure_isv.elastic.open_ai
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND integration_name = '{{ integration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_status

Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance. Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance.

EXEC azure_isv.elastic.open_ai.get_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@integration_name='{{ integration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;