跳到主要內容

已不再支援此瀏覽器。

請升級至 Microsoft Edge,以利用最新功能、安全性更新和技術支援。

下載 Microsoft Edge Internet Explorer 和 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.

查詢參數

api-version string 必要

The API version to use for this operation.

路徑參數

name string 必要

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

標頭參數

x-ms-client-request-id string

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

回覆

The request has succeeded.

標題

x-ms-client-request-id string

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

主體

Content-Type: application/json
name string 必要

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

id string 必要

A unique identifier for the connection, generated by the service

type string | enum 必要

The Type (or category) of the connection

以下任何一項:
string
enum
AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_PreviewOpenAPIRemoteA2A
target string 必要

The connection URL to be used for this service

isDefault boolean 必要

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

credentials ApiKey | AAD | CustomKeys | SAS | None | AgenticIdentityToken_Preview 必要

A base class for connection credentials

下列其中一項:
ApiKey ApiKeyCredentials

API Key Credential definition

type enum 必要

The credential type

ApiKey
key string

API Key

AAD EntraIDCredentials

Entra ID credential definition

type enum 必要

The credential type

AAD
CustomKeys CustomCredential

Custom credential definition

type enum 必要

The credential type

CustomKeys
SAS SASCredentials

Shared Access Signature (SAS) credential definition

type enum 必要

The credential type

SAS
SAS string

SAS token

None NoAuthenticationCredentials

Credentials that do not require authentication

type enum 必要

The credential type

None
AgenticIdentityToken_Preview AgenticIdentityPreviewCredentials

Agentic identity credential definition

type enum 必要

The credential type

AgenticIdentityToken_Preview
metadata object 必要

Metadata of the connection

[key: string] string

Client error

標題

x-ms-error-code string

String error code indicating what went wrong.

主體

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

The error object.

code string 必要

One of a server-defined set of error codes.

message string 必要

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

標題

x-ms-error-code string

String error code indicating what went wrong.

主體

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

The error object.

code string 必要

One of a server-defined set of error codes.

message string 必要

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

Request

GET /connections/{name} HTTP/1.1

回應

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
zh-tw
您的隱私權選擇
  • AI 免責聲明
  • 舊版本
  • 部落格
  • 參與
  • 隱私權
  • 消費者健康隱私
  • 使用規定
  • 商標
  • © Microsoft 2026