Connections

Get a connection

GET /connections/{name}

Retrieves the specified connection and its configuration details without including credential values.

Параметры запроса

api-version string обязательно

The API version to use for this operation.

Параметры пути

name string обязательно

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

Параметры заголовка

x-ms-client-request-id string

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

Ответы

The request has succeeded.

Заголовки

x-ms-client-request-id string

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

Текст

Content-Type: application/json

name string обязательно

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

id string обязательно

A unique identifier for the connection, generated by the service

type string | enum обязательно

The Type (or category) of the connection

Любое из следующих:

string

enum

AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A

target string обязательно

The connection URL to be used for this service

isDefault boolean обязательно

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

A base class for connection credentials

Один из следующих:

ApiKey ApiKeyCredentials

API Key Credential definition

type enum обязательно

The credential type

ApiKey

key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum обязательно

The credential type

AAD

CustomKeys CustomCredential

Custom credential definition

type enum обязательно

The credential type

CustomKeys

SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum обязательно

The credential type

SAS

SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum обязательно

The credential type

None

AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum обязательно

The credential type

AgenticIdentityToken_Preview

metadata object обязательно

Metadata of the connection

[key: string] string

Запрос

GET /connections/{name} HTTP/1.1

Response

Status: 200
Content-Type: application/json

Status: 4XX
Content-Type: application/json

Status: 5XX
Content-Type: application/json