Sign in

v3

latestSwagger 2.02026-07-132961114.8 KB

Get a connection by name, without populating connection credentials

get/connections/{name}

Path parameters

namestring required

The friendly name of the connection, provided by the user.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

x-ms-client-request-idstring uuid

An opaque, globally-unique, client-generated string identifier for the request.

Response

The request has succeeded.

namestring required

The friendly name of the connection, provided by the user.

idstring required

A unique identifier for the connection, generated by the service

type'AzureOpenAI' | 'AzureBlob' | 'AzureStorageAccount' | 'CognitiveSearch' | 'CosmosDB' | 'ApiKey' | 'AppConfig' | 'AppInsights' | 'CustomKeys' required

The Type (or category) of the connection

targetstring required

The connection URL to be used for this service

isDefaultboolean required

Whether the connection is tagged as the default connection of its type

metadataobject required

Metadata of the connection