New-AzMLWorkspaceCommandJobObject
Create an in-memory object for CommandJob.
Syntax
New-AzMLWorkspaceCommandJobObject
-Command <String>
-EnvironmentId <String>
[-CodeId <String>]
[-ComputeId <String>]
[-Description <String>]
[-DisplayName <String>]
[-DistributionType <DistributionType>]
[-EnvironmentVariable <Hashtable>]
[-ExperimentName <String>]
[-IdentityType <IdentityConfigurationType>]
[-IsArchived <Boolean>]
[-JobInput <ICommandJobInputs>]
[-JobOutput <ICommandJobOutputs>]
[-LimitTimeout <TimeSpan>]
[-Property <IResourceBaseProperties>]
[-ResourceInstanceCount <Int32>]
[-ResourceInstanceType <String>]
[-ResourceProperty <IResourceConfigurationProperties>]
[-ServiceEndpoint <String>]
[-ServicePort <Int32>]
[-ServiceProperty <IJobServiceProperties>]
[-ServiceType <String>]
[-Tag <IResourceBaseTags>]
[<CommonParameters>] Description
Create an in-memory object for CommandJob.
Examples
Example 1: Create an in-memory object for CommandJob
# You can use following commands to create job input or job oupt as vaule pass to JobInput or JobOutput parameter of the New-AzMLWorkspaceCommandJobObject
# New-AzMLWorkspaceCustomModelJobInputObject
# New-AzMLWorkspaceCustomModelJobOutputObject
# New-AzMLWorkspaceLiteralJobInputObject
# New-AzMLWorkspaceMLFlowModelJobInputObject
# New-AzMLWorkspaceMLFlowModelJobOutputObject
# New-AzMLWorkspaceMLTableJobInputObject
# New-AzMLWorkspaceMLTableJobOutputObject
# New-AzMLWorkspaceSharedPrivateLinkResourceObject
# New-AzMLWorkspaceTritonModelJobInputObject
# New-AzMLWorkspaceTritonModelJobOutputObject
# New-AzMLWorkspaceUriFileJobInputObject
# New-AzMLWorkspaceUriFileJobOutputObject
# New-AzMLWorkspaceUriFolderJobInputObject
# New-AzMLWorkspaceUriFolderJobOutputObject
New-AzMLWorkspaceCommandJobObject -Command "echo `"hello world`"" `
-ComputeId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/computes/aml02' `
-EnvironmentId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/environments/commandjobenv/versions/1'`
-DisplayName 'commandjob01' -ExperimentName 'commandjobexperiment'Create an in-memory object for CommandJob.
Parameters
-CodeId
ARM resource ID of the code asset.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Command
[Required] The command to execute on startup of the job. eg. "python train.py".
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputeId
ARM resource ID of the compute resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
The asset description text.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Display name of job.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DistributionType
[Required] Specifies the type of distribution framework.
| Type: | DistributionType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnvironmentId
[Required] The ARM resource ID of the Environment specification for the job.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnvironmentVariable
Environment variables included in the job.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExperimentName
The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityType
[Required] Specifies the type of identity framework.
| Type: | IdentityConfigurationType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsArchived
Is the asset archived?.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobInput
Mapping of input data bindings used in the job. To construct, see NOTES section for JOBINPUT properties and create a hash table.
| Type: | ICommandJobInputs |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobOutput
Mapping of output data bindings used in the job. To construct, see NOTES section for JOBOUTPUT properties and create a hash table.
| Type: | ICommandJobOutputs |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LimitTimeout
The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
The asset property dictionary. To construct, see NOTES section for PROPERTY properties and create a hash table.
| Type: | IResourceBaseProperties |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceInstanceCount
Optional number of instances or nodes used by the compute target.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceInstanceType
Optional type of VM used as supported by the compute target.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceProperty
Additional properties bag. To construct, see NOTES section for RESOURCEPROPERTY properties and create a hash table.
| Type: | IResourceConfigurationProperties |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceEndpoint
Url for endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePort
Port for endpoint.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceProperty
Additional properties to set on the endpoint. To construct, see NOTES section for SERVICEPROPERTY properties and create a hash table.
| Type: | IJobServiceProperties |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceType
Endpoint type.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Tag dictionary. Tags can be added, removed, and updated. To construct, see NOTES section for TAG properties and create a hash table.
| Type: | IResourceBaseTags |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
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.
JOBINPUT <ICommandJobInputs>: Mapping of input data bindings used in the job.
[(Any) <IJobInput>]: This indicates any property can be added to this object.
JOBOUTPUT <ICommandJobOutputs>: Mapping of output data bindings used in the job.
[(Any) <IJobOutput>]: This indicates any property can be added to this object.
PROPERTY <IResourceBaseProperties>: The asset property dictionary.
[(Any) <String>]: This indicates any property can be added to this object.
RESOURCEPROPERTY <IResourceConfigurationProperties>: Additional properties bag.
[(Any) <Object>]: This indicates any property can be added to this object.
SERVICEPROPERTY <IJobServiceProperties>: Additional properties to set on the endpoint.
[(Any) <String>]: This indicates any property can be added to this object.
TAG <IResourceBaseTags>: Tag dictionary. Tags can be added, removed, and updated.
[(Any) <String>]: This indicates any property can be added to this object.