Lompati ke konten utama

Browser ini sudah tidak didukung.

Tingkatkan ke Microsoft Edge untuk memanfaatkan fitur, pembaruan keamanan, dan dukungan teknis terkini.

Unduh Microsoft Edge Informasi selengkapnya tentang Internet Explorer dan 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.

Parameter kueri

api-version string diperlukan

The API version to use for this operation.

Parameter jalur

name string diperlukan

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

Parameter header

x-ms-client-request-id string

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

Respons

The request has succeeded.

Header

x-ms-client-request-id string

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

Isi

Content-Type: application/json
name string diperlukan

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

id string diperlukan

A unique identifier for the connection, generated by the service

type string | enum diperlukan

The Type (or category) of the connection

Salah satu dari yang berikut:
string
enum
AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A
target string diperlukan

The connection URL to be used for this service

isDefault boolean diperlukan

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

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

A base class for connection credentials

Salah satu dari berikut ini:
ApiKey ApiKeyCredentials

API Key Credential definition

type enum diperlukan

The credential type

ApiKey
key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum diperlukan

The credential type

AAD
CustomKeys CustomCredential

Custom credential definition

type enum diperlukan

The credential type

CustomKeys
SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum diperlukan

The credential type

SAS
SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum diperlukan

The credential type

None
AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum diperlukan

The credential type

AgenticIdentityToken_Preview
metadata object diperlukan

Metadata of the connection

[key: string] string

Client error

Header

x-ms-error-code string

String error code indicating what went wrong.

Isi

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

The error object.

code string diperlukan

One of a server-defined set of error codes.

message string diperlukan

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.

Isi

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

The error object.

code string diperlukan

One of a server-defined set of error codes.

message string diperlukan

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

Minta

GET /connections/{name} HTTP/1.1

Tanggapan

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
id-id
Pilihan Privasi Anda
  • Pengelakan AI
  • Versi Sebelumnya
  • Blog
  • Berikan kontribusi
  • Privasi
  • Privasi Kesehatan Konsumen
  • Persyaratan Penggunaan
  • Merek Dagang
  • © Microsoft 2026