Get-AzMLWorkspaceCompute

Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

Syntax

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

Description

Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

Examples

Example 1: Lists all computes under a workspace

Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01

Name          SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName
----          ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- -----------------
cpu-cluster                                                                                                                                                                      eastus   ml-rg-test
gpu-cluster                                                                                                                                                                      eastus   ml-rg-test
batch-cluster                                                                                                                                                                    eastus   ml-rg-test

Lists all computes under a workspace

Example 2: Gets a compute by name

Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name cpu-cluster

Name        SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName
----        ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- -----------------
cpu-cluster                                                                                                                                                                    eastus   ml-rg-test

Gets a compute by name

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 the Azure Machine Learning compute.

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

-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

IComputeResource

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.