Get-AzMLWorkspaceConnection

  • Reference
Module:
Az.MachineLearningServices

Get a new workspace connection

Syntax

Get-AzMLWorkspaceConnection
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-Category <String>]
   [-Target <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceConnection
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceConnection
   -InputObject <IMachineLearningServicesIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a new workspace connection

Examples

Example 1: Lists all connection under a workspace

Get-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01

Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName
---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -----------------
test                                                                                                                                                ml-rg-test

Lists all connection under a workspace

Example 2: Gets a connection by name

Get-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name test

Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName
---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -----------------
test                                                                                                                                                ml-rg-test

Gets a connection by name

Parameters

-Category

Category of the workspace connection.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IMachineLearningServicesIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Friendly name of the workspace connection

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Target

Target of the workspace connection.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Azure Machine Learning workspace.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IMachineLearningServicesIdentity

Outputs

IWorkspaceConnectionPropertiesV2BasicResource