Connections

Get a connection

GET /connections/{name}

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

Parametry dotazů

api-version string vyžadováno

The API version to use for this operation.

Parametry cesty

name string vyžadováno

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

Parametry záhlaví

x-ms-client-request-id string

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

Odpovědi

The request has succeeded.

Hlavičky

x-ms-client-request-id string

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

Text

Content-Type: application/json

name string vyžadováno

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

id string vyžadováno

A unique identifier for the connection, generated by the service

type string | enum vyžadováno

The Type (or category) of the connection

Některá z následujících možností:

string

enum

AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A

target string vyžadováno

The connection URL to be used for this service

isDefault boolean vyžadováno

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

A base class for connection credentials

Jeden z následujících:

ApiKey ApiKeyCredentials

API Key Credential definition

type enum vyžadováno

The credential type

ApiKey

key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum vyžadováno

The credential type

AAD

CustomKeys CustomCredential

Custom credential definition

type enum vyžadováno

The credential type

CustomKeys

SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum vyžadováno

The credential type

SAS

SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum vyžadováno

The credential type

None

AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum vyžadováno

The credential type

AgenticIdentityToken_Preview

metadata object vyžadováno

Metadata of the connection

[key: string] string

Žádost

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