Get-AzMLWorkspace

Gets the properties of the specified machine learning workspace.

Syntax

Get-AzMLWorkspace
   [-SubscriptionId <String[]>]
   [-Skip <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspace
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspace
   -InputObject <IMachineLearningServicesIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspace
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Skip <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the properties of the specified machine learning workspace.

Examples

Example 1: List the properties of the specified machine learning workspace under a subscription

Get-AzMLWorkspace

Name                 SystemDataCreatedAt  SystemDataCreatedBy  SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName
----                 -------------------  -------------------  ----------------------- ------------------------ ------------------------ ---------------------------- -------- -----------------
mlworkspace-portal01 5/5/2022 1:27:26 AM  v-diya@microsoft.com User                    5/5/2022 1:27:26 AM      v-diya@microsoft.com     User                         eastus   ml-rg-test
mlworkspace-cli01    5/18/2022 6:33:49 AM v-diya@microsoft.com User                    5/18/2022 6:33:49 AM     v-diya@microsoft.com     User                         eastus   ml-rg-test
mlworkspace-demo     5/25/2022 3:06:22 AM v-diya@microsoft.com User                    5/25/2022 3:06:22 AM     v-diya@microsoft.com     User                         eastus   ml-rg-test

List the properties of the specified machine learning workspace under a subscription.

Example 2: List the properties of the specified machine learning workspace under a resource group

Get-AzMLWorkspace -ResourceGroupName ml-rg-test

Name                 SystemDataCreatedAt  SystemDataCreatedBy  SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName
----                 -------------------  -------------------  ----------------------- ------------------------ ------------------------ ---------------------------- -------- -----------------
mlworkspace-portal01 5/5/2022 1:27:26 AM  v-diya@microsoft.com User                    5/5/2022 1:27:26 AM      v-diya@microsoft.com     User                         eastus   ml-rg-test
mlworkspace-cli01    5/18/2022 6:33:49 AM v-diya@microsoft.com User                    5/18/2022 6:33:49 AM     v-diya@microsoft.com     User                         eastus   ml-rg-test
mlworkspace-demo     5/25/2022 3:06:22 AM v-diya@microsoft.com User                    5/25/2022 3:06:22 AM     v-diya@microsoft.com     User                         eastus   ml-rg-test

List the properties of the specified machine learning workspace under a resource group.

Example 3: Gets the properties of the specified machine learning workspace

Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-cli01

Name              SystemDataCreatedAt  SystemDataCreatedBy  SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName
----              -------------------  -------------------  ----------------------- ------------------------ ------------------------ ---------------------------- -------- -----------------
mlworkspace-cli01 5/18/2022 6:33:49 AM v-diya@microsoft.com User                    5/18/2022 6:33:49 AM     v-diya@microsoft.com     User                         eastus   ml-rg-test

Gets the properties of the specified machine learning workspace.

Parameters

-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

Name of Azure Machine Learning workspace.

Type:String
Aliases:WorkspaceName
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

-Skip

Continuation token for pagination.

Type:String
Position:Named
Default value:None
Required:False
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

Inputs

IMachineLearningServicesIdentity

Outputs

IWorkspace

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.