Connections - List

Servicio:

AI Foundry

Versión de la API:

v1

Enumerar todas las conexiones del proyecto, sin rellenar las credenciales de conexión

GET {endpoint}/connections?api-version=v1

Con parámetros opcionales:

GET {endpoint}/connections?api-version=v1&connectionType={connectionType}&defaultConnection={defaultConnection}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto final del proyecto. En la forma "https://.services.ai.azure.com/api/projects/_project" si su Foundry Hub tiene solo un proyecto, o para usar el proyecto predeterminado en su Hub. O en la forma "https://.services.ai.azure.com/api/projects/" si desea especificar explícitamente el nombre del proyecto de fundición.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
connectionType	query		ConnectionType	Enumerar conexiones de este tipo específico
defaultConnection	query		boolean	Enumerar las conexiones que son conexiones predeterminadas

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	PagedConnection	La solicitud se ha realizado correctamente. Encabezados x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

Connections_List_MaximumSet

Solicitud de ejemplo

HTTP

GET {endpoint}/connections?api-version=v1&connectionType=AzureOpenAI&defaultConnection=True

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "name": "we",
      "id": "unique-id",
      "type": "AzureOpenAI",
      "target": "bbzo",
      "isDefault": true,
      "credentials": {
        "type": "BaseCredentials"
      },
      "metadata": {
        "key9765": "voknfqanbxnseqg"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definiciones

Nombre	Description
ApiKeyCredentials	Definición de credenciales de clave de API
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Connection	Operaciones de respuesta de la lista y obtención de conexiones
ConnectionType	Tipo (o categoría) de la conexión
CredentialType	El tipo de credencial utilizado por la conexión
CustomCredential	Definición de credenciales personalizadas
EntraIDCredentials	Definición de credencial de Entra ID
NoAuthenticationCredentials	Credenciales que no requieren autenticación
PagedConnection	Colección paginada de objetos de conexión
SASCredentials	Definición de credenciales de firma de acceso compartido (SAS)

ApiKeyCredentials

Object

Definición de credenciales de clave de API

Nombre	Tipo	Description
key	string	Clave de API
type	string: ApiKey	El tipo de credencial utilizada por la conexión

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Una representación en lenguaje natural del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

Connection

Object

Operaciones de respuesta de la lista y obtención de conexiones

Nombre	Tipo	Description
credentials	BaseCredentials: ApiKeyCredentials CustomCredential EntraIDCredentials NoAuthenticationCredentials SASCredentials	Las credenciales utilizadas por la conexión
id	string	Un identificador único para la conexión, generado por el servicio
isDefault	boolean	Si la conexión está etiquetada como la conexión predeterminada de su tipo
metadata	object	Metadatos de la conexión
name	string	El nombre descriptivo de la conexión, proporcionado por el usuario.
target	string	Dirección URL de conexión que se va a usar para este servicio
type	ConnectionType	Categoría de la conexión

ConnectionType

Enumeración

Tipo (o categoría) de la conexión

Valor	Description
ApiKey	Conexión genérica que utiliza la autenticación de clave de API
AppConfig	Configuración de aplicaciones
AppInsights	Application Insights
AzureBlob	Azure Blob Storage, con contenedor especificado
AzureOpenAI	Servicio Azure OpenAI
AzureStorageAccount	Azure Blob Storage, con contenedor no especificado (usado por los agentes)
CognitiveSearch	Azure AI Search
CosmosDB	CosmosDB
CustomKeys	Teclas personalizadas

CredentialType

Enumeración

El tipo de credencial utilizado por la conexión

Valor	Description
AAD	Credencial de ID de Entra (anteriormente conocida como AAD)
ApiKey	Credencial de clave de API
CustomKeys	Credencial personalizada
None	Sin credencial
SAS	Credencial de firma de acceso compartido (SAS)

CustomCredential

Object

Definición de credenciales personalizadas

Nombre	Tipo	Description
keys	object	Tipo de credencial
type	string: CustomKeys	El tipo de credencial utilizada por la conexión

EntraIDCredentials

Object

Definición de credencial de Entra ID

Nombre	Tipo	Description
type	string: AAD	El tipo de credencial utilizada por la conexión

NoAuthenticationCredentials

Object

Credenciales que no requieren autenticación

Nombre	Tipo	Description
type	string: None	El tipo de credencial utilizada por la conexión

PagedConnection

Object

Colección paginada de objetos de conexión

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Connection[]	Los elementos de conexión de esta página

SASCredentials

Object

Definición de credenciales de firma de acceso compartido (SAS)

Nombre	Tipo	Description
SAS	string	Token de SAS
type	string: SAS	El tipo de credencial utilizada por la conexión