Connections

Get a connection

GET /connections/{name}

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

Parámetros de consulta

api-version string requerido

The API version to use for this operation.

Parámetros de la ruta de acceso

name string requerido

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

Parámetros de encabezado

x-ms-client-request-id string

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

Respuestas

The request has succeeded.

Encabezados

x-ms-client-request-id string

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

Cuerpo

Content-Type: application/json

name string requerido

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

id string requerido

A unique identifier for the connection, generated by the service

type string | enum requerido

The Type (or category) of the connection

Cualquiera de las siguientes:

string

enum

AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A

target string requerido

The connection URL to be used for this service

isDefault boolean requerido

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

A base class for connection credentials

Uno de los siguientes:

ApiKey ApiKeyCredentials

API Key Credential definition

type enum requerido

The credential type

ApiKey

key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum requerido

The credential type

AAD

CustomKeys CustomCredential

Custom credential definition

type enum requerido

The credential type

CustomKeys

SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum requerido

The credential type

SAS

SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum requerido

The credential type

None

AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum requerido

The credential type

AgenticIdentityToken_Preview

metadata object requerido

Metadata of the connection

[key: string] string

Solicitar

GET /connections/{name} HTTP/1.1

Respuesta

Status: 200
Content-Type: application/json

Status: 4XX
Content-Type: application/json

Status: 5XX
Content-Type: application/json