Workspace Connections - List

Reference

Service:: Machine Learning

API Version:: 2023-10-01

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections?api-version=2023-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections?target={target}&category={category}&api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	The API version to use for this operation.
category	query		string	Category of the workspace connection.
target	query		string	Target of the workspace connection.

Responses

Name	Type	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult	The request was successful; the request was well-formed and received properly.
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListWorkspaceConnections

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections?target=www.facebook.com&category=ContainerRegistry&api-version=2023-10-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1",
      "name": "connection-1",
      "type": "Microsoft.MachineLearningServices/workspaces/connections",
      "properties": {
        "category": "ContainerRegistry",
        "target": "www.facebook.com",
        "authType": "PAT"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2",
      "name": "connection-2",
      "type": "Microsoft.MachineLearningServices/workspaces/connections",
      "properties": {
        "category": "ContainerRegistry",
        "target": "www.facebook.com",
        "authType": "PAT"
      }
    }
  ]
}

Definitions

Name	Description
ConnectionAuthType	Authentication type of the connection target
ConnectionCategory	Category of the connection
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
systemData	Metadata pertaining to creation and last modification of the resource.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	format for the workspace connection value
WorkspaceConnectionManagedIdentity
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

ConnectionAuthType

Authentication type of the connection target

Name	Type	Description
ManagedIdentity	string
None	string
PAT	string
SAS	string
UsernamePassword	string

ConnectionCategory

Category of the connection

Name	Type	Description
ContainerRegistry	string
Git	string
PythonFeed	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: ManagedIdentity	Authentication type of the connection target
category	ConnectionCategory	Category of the connection
credentials	WorkspaceConnectionManagedIdentity
target	string
value	string	Value details of the workspace connection.
valueFormat	ValueFormat	format for the workspace connection value

NoneAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: None	Authentication type of the connection target
category	ConnectionCategory	Category of the connection
target	string
value	string	Value details of the workspace connection.
valueFormat	ValueFormat	format for the workspace connection value

PATAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: PAT	Authentication type of the connection target
category	ConnectionCategory	Category of the connection
credentials	WorkspaceConnectionPersonalAccessToken
target	string
value	string	Value details of the workspace connection.
valueFormat	ValueFormat	format for the workspace connection value

SASAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: SAS	Authentication type of the connection target
category	ConnectionCategory	Category of the connection
credentials	WorkspaceConnectionSharedAccessSignature
target	string
value	string	Value details of the workspace connection.
valueFormat	ValueFormat	format for the workspace connection value

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: UsernamePassword	Authentication type of the connection target
category	ConnectionCategory	Category of the connection
credentials	WorkspaceConnectionUsernamePassword
target	string
value	string	Value details of the workspace connection.
valueFormat	ValueFormat	format for the workspace connection value

ValueFormat

format for the workspace connection value

Name	Type	Description
JSON	string

WorkspaceConnectionManagedIdentity

Name	Type	Description
clientId	string
resourceId	string

WorkspaceConnectionPersonalAccessToken

Name	Type	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	WorkspaceConnectionPropertiesV2: ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult

Name	Type	Description
nextLink	string
value	WorkspaceConnectionPropertiesV2BasicResource[]

WorkspaceConnectionSharedAccessSignature

Name	Type	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Type	Description
password	string
username	string