Connections

Get a connection

GET /connections/{name}

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

Paramètres de la requête

api-version string obligatoire

The API version to use for this operation.

Paramètres de chemin d’accès

name string obligatoire

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

Paramètres d’en-tête

x-ms-client-request-id string

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

Réponses

The request has succeeded.

En-têtes

x-ms-client-request-id string

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

Corps

Content-Type: application/json

name string obligatoire

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

id string obligatoire

A unique identifier for the connection, generated by the service

type string | enum obligatoire

The Type (or category) of the connection

Un des éléments suivants :

string

enum

AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A

target string obligatoire

The connection URL to be used for this service

isDefault boolean obligatoire

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

A base class for connection credentials

Celui-ci peut avoir l'une des valeurs suivantes :

ApiKey ApiKeyCredentials

API Key Credential definition

type enum obligatoire

The credential type

ApiKey

key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum obligatoire

The credential type

AAD

CustomKeys CustomCredential

Custom credential definition

type enum obligatoire

The credential type

CustomKeys

SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum obligatoire

The credential type

SAS

SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum obligatoire

The credential type

None

AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum obligatoire

The credential type

AgenticIdentityToken_Preview

metadata object obligatoire

Metadata of the connection

[key: string] string

Requête

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