Hoppa till huvudinnehåll

Den här webbläsaren stöds inte längre.

Uppgradera till Microsoft Edge och dra nytta av de senaste funktionerna och säkerhetsuppdateringarna, samt teknisk support.

Ladda ned Microsoft Edge Mer information om Internet Explorer och 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.

Frågeparametrar

api-version string krävs

The API version to use for this operation.

Sökvägsparametrar

name string krävs

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

Rubrikparametrar

x-ms-client-request-id string

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

Svar

The request has succeeded.

Sidhuvuden

x-ms-client-request-id string

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

Brödtext

Content-Type: application/json
name string krävs

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

id string krävs

A unique identifier for the connection, generated by the service

type string | enum krävs

The Type (or category) of the connection

Något av följande:
string
enum
AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A
target string krävs

The connection URL to be used for this service

isDefault boolean krävs

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

credentials ApiKey | AAD | CustomKeys | SAS | None | AgenticIdentityToken_Preview krävs

A base class for connection credentials

Något av följande:
ApiKey ApiKeyCredentials

API Key Credential definition

type enum krävs

The credential type

ApiKey
key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum krävs

The credential type

AAD
CustomKeys CustomCredential

Custom credential definition

type enum krävs

The credential type

CustomKeys
SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum krävs

The credential type

SAS
SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum krävs

The credential type

None
AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum krävs

The credential type

AgenticIdentityToken_Preview
metadata object krävs

Metadata of the connection

[key: string] string

Client error

Sidhuvuden

x-ms-error-code string

String error code indicating what went wrong.

Brödtext

Content-Type: application/json
error Azure.Core.Foundations.Error krävs

The error object.

code string krävs

One of a server-defined set of error codes.

message string krävs

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

Sidhuvuden

x-ms-error-code string

String error code indicating what went wrong.

Brödtext

Content-Type: application/json
error Azure.Core.Foundations.Error krävs

The error object.

code string krävs

One of a server-defined set of error codes.

message string krävs

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

Förfrågan

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
sv-se
Dina sekretessalternativ
  • Ansvarsfriskrivning för AI
  • Tidigare versioner
  • Blogg
  • Bidra
  • Sekretess
  • Konsumenthälsans integritet
  • Användningsvillkor
  • Varumärken
  • © Microsoft 2026