Skip to content

Remove listing connections with credentials #34148

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 5 commits into from
Apr 24, 2025
Merged

Remove listing connections with credentials #34148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46af3a3
Save work
dargilco Apr 23, 2025
7d30e17
Merge remote-tracking branch 'origin/feature/azure-ai-projects-1dp' i…
dargilco Apr 23, 2025
5548c6d
Add swagger
dargilco Apr 23, 2025
8855a0d
address Yanxiang's comment on IM
dargilco Apr 23, 2025
636d2c0
Suggestions for handling custom credentials
dargilco Apr 23, 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
23 changes: 14 additions & 9 deletions specification/ai/Azure.AI.Projects/connections/models.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ namespace Azure.AI.Projects;

@doc("Response from the list and get connections operations")
@resource("connections")
@discriminator("authType")
@added(Versions.v2025_05_01)
model Connection {
@doc("The name of the resource")
Expand Down Expand Up @@ -42,21 +41,22 @@ model Connection {
}

@doc("A base class for connection credentials")
@discriminator("authType")
@discriminator("type")
model BaseCredentials {
@doc("The type of credential used by the connection")
@visibility(Lifecycle.Read)
authType: CredentialType;
type: CredentialType;
}

@doc("API Key Credential definition")
model ApiKeyCredentials extends BaseCredentials {
@doc("The credentail type")
@visibility(Lifecycle.Read)
authType: CredentialType.apiKey;
type: CredentialType.apiKey;

@doc("API Key")
@visibility(Lifecycle.Read)
@encodedName("application/json", "key")
apiKey?: string;
}

Expand All @@ -65,33 +65,38 @@ model ApiKeyCredentials extends BaseCredentials {
model EntraIDCredentials extends BaseCredentials {
@doc("The credential type")
@visibility(Lifecycle.Read)
authType: CredentialType.entraId;
type: CredentialType.entraId;
}

@doc("Custom credential defintion")
model CustomCredential extends BaseCredentials {
@doc("The credential type ")
@doc("The credential type")
@visibility(Lifecycle.Read)
type: CredentialType.custom;

@doc("The credential type")
@visibility(Lifecycle.Read)
authType: CredentialType.custom;
keys: Record<string>;
}

#suppress "@azure-tools/typespec-azure-core/casing-style"
@doc("Shared Access Signature (SAS) credential definition")
model SASCredentials extends BaseCredentials {
@doc("The credential type")
@visibility(Lifecycle.Read)
authType: CredentialType.SAS;
type: CredentialType.SAS;

@doc("SAS token")
@visibility(Lifecycle.Read)
@encodedName("application/json", "SAS")
sasToken?: string;
}

@doc("Credentials that do not require authentication")
model NoAuthenticationCredentials extends BaseCredentials {
@doc("The credential type ")
@visibility(Lifecycle.Read)
authType: CredentialType.None;
type: CredentialType.None;
}

// https://learn.microsoft.com/rest/api/azureml/workspace-connections/list-secrets?view=rest-azureml-2024-04-01&tabs=HTTP#ConnectionType
Expand Down
24 changes: 0 additions & 24 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 @@ -47,28 +47,4 @@ interface Connections {
...StandardListQueryParameters;
}>
>;

@doc("List all connections in the project, with their connection credentials")
@TypeSpec.Http.post
@Rest.actionSeparator("/")
@Rest.action("withCredentials")
listWithCredentials is ConnectionOperations.ResourceCollectionAction<
Connection,
{
@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>;
}
186 changes: 22 additions & 164 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,135 +277,6 @@
}
}
},
"/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 Agents)"
},
{
"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 @@ -1763,10 +1634,11 @@
"type": "object",
"description": "API Key Credential definition",
"properties": {
"apiKey": {
"key": {
"type": "string",
"description": "API Key",
"readOnly": true
"readOnly": true,
"x-ms-client-name": "apiKey"
}
},
"allOf": [
Expand Down Expand Up @@ -2050,15 +1922,15 @@
"type": "object",
"description": "A base class for connection credentials",
"properties": {
"authType": {
"type": {
"$ref": "#/definitions/CredentialType",
"description": "The type of credential used by the connection",
"readOnly": true
}
},
"discriminator": "authType",
"discriminator": "type",
"required": [
"authType"
"type"
]
},
"BlobReferenceForConsumption": {
Expand Down Expand Up @@ -2088,10 +1960,6 @@
"type": "object",
"description": "Response from the list and get connections operations",
"properties": {
"authType": {
"type": "string",
"description": "Discriminator property for Connection."
},
"name": {
"type": "string",
"description": "The name of the resource",
Expand Down Expand Up @@ -2126,9 +1994,7 @@
"readOnly": true
}
},
"discriminator": "authType",
"required": [
"authType",
"name",
"type",
"target",
Expand Down Expand Up @@ -2304,6 +2170,19 @@
"CustomCredential": {
"type": "object",
"description": "Custom credential defintion",
"properties": {
"keys": {
"type": "object",
"description": "The credential type",
"additionalProperties": {
"type": "string"
},
"readOnly": true
}
},
"required": [
"keys"
],
"allOf": [
{
"$ref": "#/definitions/BaseCredentials"
Expand Down Expand Up @@ -2820,28 +2699,6 @@
],
"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 Expand Up @@ -3346,10 +3203,11 @@
"type": "object",
"description": "Shared Access Signature (SAS) credential definition",
"properties": {
"sasToken": {
"SAS": {
"type": "string",
"description": "SAS token",
"readOnly": true
"readOnly": true,
"x-ms-client-name": "sasToken"
}
},
"allOf": [
Expand Down
Loading
Loading