Get-AzMLWorkspaceBatchDeployment

Gets a batch inference deployment by id.

Syntax

Get-AzMLWorkspaceBatchDeployment
   -EndpointName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-OrderBy <String>]
   [-Skip <String>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceBatchDeployment
   -EndpointName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzMLWorkspaceBatchDeployment
   -InputObject <IMachineLearningServicesIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a batch inference deployment by id.

Examples

Example 1: Lists all batch inference deployment under a batch endpoint

Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-cli02

Location Name        SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind ResourceGroupName
-------- ----        ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- -----------------
eastus   nonmlflowdp 6/1/2022 6:19:16 AM UserName (Example)                          6/1/2022 6:19:16 AM                                                                 ml-rg-test

Lists all batch inference deployment under a batch endpoint

Example 2: Gets a batch inference deployment by Name

Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-cli02 -Name nonmlflowdp

Location Name        SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind ResourceGroupName
-------- ----        ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- -----------------
eastus   nonmlflowdp 6/1/2022 6:19:16 AM UserName (Example)                          6/1/2022 6:19:16 AM                                                                 ml-rg-test

Gets a batch inference deployment by Name

Parameters

-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

-EndpointName

Endpoint name

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

The identifier for the Batch deployments.

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

-OrderBy

Ordering of list.

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

-Top

Top of list.

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

Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IBatchDeployment