Zu Hauptinhalt wechseln

Dieser Browser wird nicht mehr unterstützt.

Führen Sie ein Upgrade auf Microsoft Edge durch, um die neuesten Features, Sicherheitsupdates und den technischen Support zu nutzen.

Microsoft Edge herunterladen Weitere Informationen zu Internet Explorer und 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.

Abfrageparameter

api-version string Erforderlich

The API version to use for this operation.

Pfadparameter

name string Erforderlich

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

Headerparameter

x-ms-client-request-id string

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

Antworten

The request has succeeded.

Header

x-ms-client-request-id string

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

Text

Content-Type: application/json
name string Erforderlich

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

id string Erforderlich

A unique identifier for the connection, generated by the service

type string | enum Erforderlich

The Type (or category) of the connection

Eines der folgenden Elemente:
string
enum
AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A
target string Erforderlich

The connection URL to be used for this service

isDefault boolean Erforderlich

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

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

A base class for connection credentials

Eins der folgenden:
ApiKey ApiKeyCredentials

API Key Credential definition

type enum Erforderlich

The credential type

ApiKey
key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum Erforderlich

The credential type

AAD
CustomKeys CustomCredential

Custom credential definition

type enum Erforderlich

The credential type

CustomKeys
SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum Erforderlich

The credential type

SAS
SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum Erforderlich

The credential type

None
AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum Erforderlich

The credential type

AgenticIdentityToken_Preview
metadata object Erforderlich

Metadata of the connection

[key: string] string

Client error

Header

x-ms-error-code string

String error code indicating what went wrong.

Text

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

The error object.

code string Erforderlich

One of a server-defined set of error codes.

message string Erforderlich

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

Header

x-ms-error-code string

String error code indicating what went wrong.

Text

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

The error object.

code string Erforderlich

One of a server-defined set of error codes.

message string Erforderlich

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

Anfordern

GET /connections/{name} HTTP/1.1

Antwort

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
de-de
Ihre Datenschutzoptionen
  • KI-Haftungsausschluss
  • Frühere Versionen
  • Blog
  • Mitwirken
  • Datenschutz
  • Consumer Health Privacy
  • Nutzungsbedingungen
  • Impressum
  • Marken
  • © Microsoft 2026