reference-yaml-connection-ai-search.md

title	titleSuffix	description	services	ms.service	ms.subservice	ms.custom	ms.topic	author	ms.author	ms.date	ms.reviewer
CLI (v2) AI Search connection YAML schema	Azure Machine Learning	Reference documentation for the CLI (v2) AI Search connections YAML schema.	machine-learning	machine-learning	core	build-2024	reference	Blackmist	larryfr	05/09/2024	ambadal

CLI (v2) Azure AI Search connection YAML schema

[!INCLUDE cli v2]

[!INCLUDE schema note]

YAML syntax

Key	Type	Description	Allowed values	Default value
$schema	string	The YAML schema. If you use the Azure Machine Learning Visual Studio Code extension to author the YAML file, include $schema at the top of your file to invoke schema and resource completions.
name	string	Required. The connection name.
description	string	The connection description.
tags	object	The connection tag dictionary.
type	string	Required. The connection type.	azure_ai_search	azure_ai_search
is_shared	boolean	true if the connection is shared across other projects in the hub; otherwise, false.		true
endpoint	string	Required. The URL of the endpoint.
api_key	string	Required. The API key used to authenticate the connection. If not provided, a Microsoft Entra ID (credential-less authentication) connection is created.

Remarks

While the az ml connection commands can be used to manage both Azure Machine Learning and Azure AI Studio connections, the Azure AI Search connection is specific to Azure AI Studio.

Examples

Visit this GitHub resource for examples. Several are shown here. These examples would be in the form of YAML files and used from the CLI. For example, az ml connection create -f <file-name>.yaml.

YAML: API key

#AzureContentSafetyConnection.yml

name: myazaics_apk
type: azure_ai_search

endpoint: https://contoso.search.windows.net/
api_key: XXXXXXXXXXXXXXX

YAML: credential-less

#AzureContentSafetyConnection.yml

name: myazaics_ei
type: azure_ai_search

endpoint: https://contoso.search.windows.net/

Next steps

• Install and use the CLI (v2)