Skip to main content
POST
/
connections
/
{name}
/
getConnectionWithCredentials
{
  "name": "<string>",
  "id": "<string>",
  "type": "AzureOpenAI",
  "target": "<string>",
  "isDefault": true,
  "credentials": {
    "type": "ApiKey"
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-ms-client-request-id
string<uuid>

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

Path Parameters

​
name
string
required

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

Query Parameters

​
api-version
string
required

The API version to use for this operation.

Minimum length: 1

Response

The request has succeeded.

Response from the list and get connections operations

​
name
string
required

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

​
id
string
required

A unique identifier for the connection, generated by the service

​
type
enum<string>
required

The Type (or category) of the connection

Available options:
AzureOpenAI,
AzureBlob,
AzureStorageAccount,
CognitiveSearch,
CosmosDB,
ApiKey,
AppConfig,
AppInsights,
CustomKeys
​
target
string
required

The connection URL to be used for this service

​
isDefault
boolean
required

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

​
credentials
object
required
​
metadata
object
required

Metadata of the connection