Get-AzMLWorkspaceBatchDeployment

Reference

Module:: Az.MachineLearningServices

Gets a batch inference deployment by id.

Syntax

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

Get-AzMLWorkspaceBatchDeployment
   -EndpointName <String>
   -Name <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <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 AzureAsyncOperation Kind ResourceGroupName
-------- ----        ------------------- -------------------                 ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- -----------------
eastus   nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America)                         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 AzureAsyncOperation Kind ResourceGroupName
-------- ----        ------------------- -------------------                 ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- -----------------
eastus   nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America)                         6/1/2022 6:19:16 AM                                                                                     ml-rg-test

Gets a batch inference deployment 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

-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

IBatchDeployment

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