Get-AzMLWorkspaceConnection

Reference

Module:: Az.MachineLearningServices

Get the connection of the specified machine learning workspace.

Syntax

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

Get-AzMLWorkspaceConnection
   -Name <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzMLWorkspaceConnection
   -InputObject <IMachineLearningServicesIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the connection of the specified machine learning workspace.

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 credentials, account, tenant, and subscription used for communication with Azure.

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

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IMachineLearningServicesIdentity>: Identity Parameter

[ComputeName <String>]: Name of the Azure Machine Learning compute.
[ConnectionName <String>]: Friendly name of the workspace connection
[DeploymentName <String>]: Inference deployment identifier.
[EndpointName <String>]: Inference Endpoint name.
[Id <String>]: The name and identifier for the Job. This is case-sensitive.
[Id1 <String>]: Resource identity path
[Location <String>]: The location for which resource usage is queried.
[Name <String>]: Container name. This is case-sensitive.
[PrivateEndpointConnectionName <String>]: The name of the private endpoint connection associated with the workspace
[ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
[SubscriptionId <String>]: The ID of the target subscription.
[Version <String>]: Version identifier. This is case-sensitive.
[WorkspaceName <String>]: Name of Azure Machine Learning workspace.

Share via