Get-AzMLWorkspaceOnlineEndpoint

  • Reference
Module:
Az.MachineLearningServices

Get Online Endpoint.

Syntax

Get-AzMLWorkspaceOnlineEndpoint
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-Name <String>]
   [-SubscriptionId <String[]>]
   [-ComputeType <EndpointComputeType>]
   [-Count <Int32>]
   [-OrderBy <OrderString>]
   [-Property <String>]
   [-Skip <String>]
   [-Tag <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceOnlineEndpoint
   -Name <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceOnlineEndpoint
   -InputObject <IMachineLearningServicesIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get Online Endpoint.

Examples

Example 1: Lists all online enpoints under a workspace

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

Location Name          SystemDataCreatedAt  SystemDataCreatedBy                 SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind    ResourceGroupName
-------- ----          -------------------  -------------------                 ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ----    -----------------
eastus   online-cli02  5/19/2022 2:49:44 AM Lucas Yao (Wicresoft North America)                         5/19/2022 2:50:27 AM                                                                               Managed ml-rg-test
eastus   online-cli01  5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America)                         5/19/2022 2:48:26 AM                                                                               Managed ml-rg-test
eastus   online-pwsh01 5/18/2022 9:44:06 AM Lucas Yao (Wicresoft North America)                         5/18/2022 9:44:48 AM                                                                               Managed ml-rg-test

Lists all online enpoints under a workspace

Example 2: Get a online enpoint by name

Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-cli01

Location Name         SystemDataCreatedAt  SystemDataCreatedBy                 SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind    ResourceGroupName
-------- ----         -------------------  -------------------                 ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ----    -----------------
eastus   online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America)                         5/19/2022 2:48:26 AM                                                                               Managed ml-rg-test

Get a online enpoint by name

Parameters

-ComputeType

EndpointComputeType to be filtered by.

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

-Count

Number of endpoints to be retrieved in a page of results.

Type:Int32
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

Online Endpoint name.

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

-OrderBy

The option to order the response.

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

-Property

A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .

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

-Tag

A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .

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

IOnlineEndpoint

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.