メイン コンテンツにスキップ

このブラウザーはサポートされなくなりました。

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

要求

GET /connections/{name} HTTP/1.1

回答

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
ja-jp
プライバシーの選択
  • AI 免責事項
  • 以前のバージョン
  • ブログ
  • 投稿
  • プライバシー
  • コンシューマーの健康に関するプライバシー
  • 利用条件
  • 商標
  • © Microsoft 2026