Connections - Get With Credentials

Service:

AI Foundry

API-versie:

v1

Een verbinding ophalen op naam, met de bijbehorende verbindingsreferenties

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Eindpunt van het project. In de vorm "https://.services.ai.azure.com/api/projects/_project" als uw Foundry Hub slechts één project heeft, of als u het standaardproject in uw hub wilt gebruiken. Of in de vorm "https://.services.ai.azure.com/api/projects/" als u de naam van het Foundry-project expliciet wilt opgeven.
name	path	True	string	De beschrijvende naam van de verbinding, verstrekt door de gebruiker.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	Connection	De aanvraag is voltooid. Kopteksten x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name	Description
https://ai.azure.com/.default

Voorbeelden

Connections_GetWithCredentials_MaximumSet

Voorbeeldaanvraag

HTTP

POST {endpoint}/connections/jqgcfdexf/getConnectionWithCredentials?api-version=v1

Voorbeeldrespons

Statuscode:

200

{
  "name": "we",
  "id": "unique-id",
  "type": "AzureOpenAI",
  "target": "bbzo",
  "isDefault": true,
  "credentials": {
    "type": "BaseCredentials"
  },
  "metadata": {
    "key9765": "voknfqanbxnseqg"
  }
}

Definities

Name	Description
ApiKeyCredentials	Definitie van API-sleutel
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Connection	Reactie uit de lijst en verbindingen ophalen bewerkingen
ConnectionType	Het type (of categorie) van de verbinding
CredentialType	Het referentietype dat door de verbinding wordt gebruikt
CustomCredential	Definitie van aangepaste referenties
EntraIDCredentials	Definitie van Entra-ID-referenties
NoAuthenticationCredentials	Referenties waarvoor geen verificatie is vereist
SASCredentials	Definitie van SAS-referenties (Shared Access Signature)

ApiKeyCredentials

Object

Definitie van API-sleutel

Name	Type	Description
key	string	API-sleutel
type	string: ApiKey	Het type referentie dat door de verbinding wordt gebruikt

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

Connection

Object

Reactie uit de lijst en verbindingen ophalen bewerkingen

Name	Type	Description
credentials	BaseCredentials: ApiKeyCredentials CustomCredential EntraIDCredentials NoAuthenticationCredentials SASCredentials	De referenties die door de verbinding worden gebruikt
id	string	Een unieke identificatiecode voor de verbinding, gegenereerd door de service
isDefault	boolean	Of de verbinding is getagd als de standaardverbinding van het type
metadata	object	Metadata van de verbinding
name	string	De beschrijvende naam van de verbinding, verstrekt door de gebruiker.
target	string	De verbindings-URL die moet worden gebruikt voor deze service
type	ConnectionType	Categorie van de verbinding

ConnectionType

Inventarisatie

Het type (of categorie) van de verbinding

Waarde	Description
ApiKey	Algemene verbinding die gebruikmaakt van API Key-verificatie
AppConfig	Toepassingsconfiguratie
AppInsights	Analyses van toepassingen
AzureBlob	Azure Blob Storage, met opgegeven container
AzureOpenAI	Azure OpenAI-service
AzureStorageAccount	Azure Blob Storage, met container niet opgegeven (gebruikt door agenten)
CognitiveSearch	Azure AI Search
CosmosDB	Cosmos DB
CustomKeys	Aangepaste toetsen

CredentialType

Inventarisatie

Het referentietype dat door de verbinding wordt gebruikt

Waarde	Description
AAD	Entra ID-referentie (voorheen bekend als AAD)
ApiKey	Referentie voor API-sleutel
CustomKeys	Aangepaste referentie
None	Geen legitimatie
SAS	Aanmeldingsgegevens voor Shared Access Signature (SAS)

CustomCredential

Object

Definitie van aangepaste referenties

Name	Type	Description
keys	object	Het type aanmeldingsgegevens
type	string: CustomKeys	Het type referentie dat door de verbinding wordt gebruikt

EntraIDCredentials

Object

Definitie van Entra-ID-referenties

Name	Type	Description
type	string: AAD	Het type referentie dat door de verbinding wordt gebruikt

NoAuthenticationCredentials

Object

Referenties waarvoor geen verificatie is vereist

Name	Type	Description
type	string: None	Het type referentie dat door de verbinding wordt gebruikt

SASCredentials

Object

Definitie van SAS-referenties (Shared Access Signature)

Name	Type	Description
SAS	string	SAS-token
type	string: SAS	Het type referentie dat door de verbinding wordt gebruikt