Skip to content

Add connection operations with credentials #33929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dargilco merged 6 commits into from
Apr 16, 2025
Merged

Add connection operations with credentials #33929

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ad81924
First try
dargilco Apr 14, 2025
f1d50d6
Apply Johan's fix. Thank you Johan!
dargilco Apr 14, 2025
0429f5e
Update operator name
dargilco Apr 14, 2025
9ab5b37
Use route separators instead of action
dargilco Apr 16, 2025
b8e2dfd
Quality gates
dargilco Apr 16, 2025
a8ac829
Merge remote-tracking branch 'origin/feature/azure-ai-projects-1dp' i…
dargilco Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply Johan's fix. Thank you Johan!
  • Loading branch information
@dargilco
dargilco committed Apr 14, 2025
commit f1d50d6988361e3c4c43f0beacd07a40244c977a
19 changes: 11 additions & 8 deletions specification/ai/Azure.AI.Projects/connections/routes.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,27 @@ interface Connections {
}>
>;

/*
@doc("List all connections in the project, with their connection credentials")
@TypeSpec.Http.post
@Rest.actionSeparator("/")
@Rest.action("withCredentials")
listWithCredentials is ConnectionOperations.ResourceList<
listWithCredentials is ConnectionOperations.ResourceCollectionAction<
Connection,
ListQueryParametersTrait<{
{
@doc("List connections of this specific type")
@query("connectionType")
connectionType?: ConnectionType;

@doc("List connections that are default connections")
@query("defaultConnection")
defaultConnection?: boolean;

...StandardListQueryParameters;
}>
},
Internal.ConnectionPaged
>;
*/
}

namespace Internal {
model ConnectionPaged is Azure.Core.Page<Connection>;
}

151 changes: 151 additions & 0 deletions ...ion/ai/data-plane/Azure.AI.Projects/preview/2025-05-15-preview/azure-ai-projects-1dp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,135 @@
}
}
},
"/connections:withCredentials": {
"post": {
"operationId": "Connections_ListWithCredentials",
"description": "List all connections in the project, with their connection credentials",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "connectionType",
"in": "query",
"description": "List connections of this specific type",
"required": false,
"type": "string",
"enum": [
"AzureOpenAI",
"AzureBlob",
"AzureStorageAccount",
"CognitiveSearch",
"CosmosDB",
"ApiKey",
"AppConfig",
"AppInsights",
"CustomKeys"
],
"x-ms-enum": {
"name": "ConnectionType",
"modelAsString": true,
"values": [
{
"name": "AzureOpenAI",
"value": "AzureOpenAI",
"description": "Azure OpenAI Service"
},
{
"name": "AzureBlobStorage",
"value": "AzureBlob",
"description": "Azure Blob Storage, with specified container"
},
{
"name": "AzureStorageAccount",
"value": "AzureStorageAccount",
"description": "Azure Blob Storage, with container not specified (used by Assistants)"
},
{
"name": "AzureAISearch",
"value": "CognitiveSearch",
"description": "Azure AI Search"
},
{
"name": "CosmosDB",
"value": "CosmosDB",
"description": "CosmosDB"
},
{
"name": "APIKey",
"value": "ApiKey",
"description": "Generic connection that uses API Key authentication"
},
{
"name": "ApplicationConfiguration",
"value": "AppConfig",
"description": "Application Configuration"
},
{
"name": "ApplicationInsights",
"value": "AppInsights",
"description": "Application Insights"
},
{
"name": "Custom",
"value": "CustomKeys",
"description": "Custom Keys"
}
]
}
},
{
"name": "defaultConnection",
"in": "query",
"description": "List connections that are default connections",
"required": false,
"type": "boolean"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/Internal.ConnectionPaged"
},
"headers": {
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/datasets": {
"get": {
"operationId": "Datasets_ListLatest",
Expand Down Expand Up @@ -2241,6 +2370,28 @@
],
"x-ms-discriminator-value": "dataset"
},
"Internal.ConnectionPaged": {
"type": "object",
"description": "Paged collection of Connection items",
"properties": {
"value": {
"type": "array",
"description": "The Connection items on this page",
"items": {
"$ref": "#/definitions/Connection"
},
"x-ms-identifiers": []
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ListSortOrder": {
"type": "string",
"description": "The available sorting options when requesting a list of response objects.",
Expand Down
151 changes: 151 additions & 0 deletions specification/ai/data-plane/Azure.AI.Projects/stable/2025-05-01/azure-ai-projects-1dp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,135 @@
}
}
},
"/connections:withCredentials": {
"post": {
"operationId": "Connections_ListWithCredentials",
"description": "List all connections in the project, with their connection credentials",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "connectionType",
"in": "query",
"description": "List connections of this specific type",
"required": false,
"type": "string",
"enum": [
"AzureOpenAI",
"AzureBlob",
"AzureStorageAccount",
"CognitiveSearch",
"CosmosDB",
"ApiKey",
"AppConfig",
"AppInsights",
"CustomKeys"
],
"x-ms-enum": {
"name": "ConnectionType",
"modelAsString": true,
"values": [
{
"name": "AzureOpenAI",
"value": "AzureOpenAI",
"description": "Azure OpenAI Service"
},
{
"name": "AzureBlobStorage",
"value": "AzureBlob",
"description": "Azure Blob Storage, with specified container"
},
{
"name": "AzureStorageAccount",
"value": "AzureStorageAccount",
"description": "Azure Blob Storage, with container not specified (used by Assistants)"
},
{
"name": "AzureAISearch",
"value": "CognitiveSearch",
"description": "Azure AI Search"
},
{
"name": "CosmosDB",
"value": "CosmosDB",
"description": "CosmosDB"
},
{
"name": "APIKey",
"value": "ApiKey",
"description": "Generic connection that uses API Key authentication"
},
{
"name": "ApplicationConfiguration",
"value": "AppConfig",
"description": "Application Configuration"
},
{
"name": "ApplicationInsights",
"value": "AppInsights",
"description": "Application Insights"
},
{
"name": "Custom",
"value": "CustomKeys",
"description": "Custom Keys"
}
]
}
},
{
"name": "defaultConnection",
"in": "query",
"description": "List connections that are default connections",
"required": false,
"type": "boolean"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/Internal.ConnectionPaged"
},
"headers": {
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "String error code indicating what went wrong."
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/datasets": {
"get": {
"operationId": "Datasets_ListLatest",
Expand Down Expand Up @@ -1781,6 +1910,28 @@
]
}
},
"Internal.ConnectionPaged": {
"type": "object",
"description": "Paged collection of Connection items",
"properties": {
"value": {
"type": "array",
"description": "The Connection items on this page",
"items": {
"$ref": "#/definitions/Connection"
},
"x-ms-identifiers": []
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ListSortOrder": {
"type": "string",
"description": "The available sorting options when requesting a list of response objects.",
Expand Down
Loading
Loading