Naar hoofdinhoud gaan

Deze browser wordt niet meer ondersteund.

Upgrade naar Microsoft Edge om te profiteren van de nieuwste functies, beveiligingsupdates en technische ondersteuning.

Microsoft Edge downloaden Meer informatie over Internet Explorer en Microsoft Edge
microsoft-foundry.rest.security.o-auth2-auth

Connections

Get a connection

GET /connections/{name}

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

Queryparameters

api-version string vereist

The API version to use for this operation.

Padparameters

name string vereist

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

Koptekstparameters

x-ms-client-request-id string

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

Antwoorden

The request has succeeded.

Kopteksten

x-ms-client-request-id string

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

Hoofdtekst

Content-Type: application/json
name string vereist

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

id string vereist

A unique identifier for the connection, generated by the service

type string | enum vereist

The Type (or category) of the connection

Een van de volgende:
string
enum
AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A
target string vereist

The connection URL to be used for this service

isDefault boolean vereist

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

credentials ApiKey | AAD | CustomKeys | SAS | None | AgenticIdentityToken_Preview vereist

A base class for connection credentials

Een van de volgende:
ApiKey ApiKeyCredentials

API Key Credential definition

type enum vereist

The credential type

ApiKey
key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum vereist

The credential type

AAD
CustomKeys CustomCredential

Custom credential definition

type enum vereist

The credential type

CustomKeys
SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum vereist

The credential type

SAS
SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum vereist

The credential type

None
AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum vereist

The credential type

AgenticIdentityToken_Preview
metadata object vereist

Metadata of the connection

[key: string] string

Client error

Kopteksten

x-ms-error-code string

String error code indicating what went wrong.

Hoofdtekst

Content-Type: application/json
error Azure.Core.Foundations.Error vereist

The error object.

code string vereist

One of a server-defined set of error codes.

message string vereist

A human-readable representation of the error.

target string

The target of the error.

details Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.

innererror Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

code string

One of a server-defined set of error codes.

innererror Azure.Core.Foundations.InnerError

Server error

Kopteksten

x-ms-error-code string

String error code indicating what went wrong.

Hoofdtekst

Content-Type: application/json
error Azure.Core.Foundations.Error vereist

The error object.

code string vereist

One of a server-defined set of error codes.

message string vereist

A human-readable representation of the error.

target string

The target of the error.

details Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.

innererror Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

code string

One of a server-defined set of error codes.

innererror Azure.Core.Foundations.InnerError

Aanvraag

GET /connections/{name} HTTP/1.1

Respons

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
nl-nl
Uw privacykeuzes
  • AI-disclaimer
  • Vorige versies
  • Blog
  • Bijdragen
  • Privacy
  • Privacy van gezondheidsdata
  • Gebruiksvoorwaarden
  • Handelsmerken
  • © Microsoft 2026