getJob

Azure Resource Manager resource envelope. API Version: 2021-03-01-preview.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
def get_job(id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            workspace_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(id: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            workspace_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:machinelearningservices:getJob
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string

The name and identifier for the Job.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

Name of Azure Machine Learning workspace.

Id string

The name and identifier for the Job.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

Name of Azure Machine Learning workspace.

id String

The name and identifier for the Job.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

Name of Azure Machine Learning workspace.

id string

The name and identifier for the Job.

resourceGroupName string

The name of the resource group. The name is case insensitive.

workspaceName string

Name of Azure Machine Learning workspace.

id str

The name and identifier for the Job.

resource_group_name str

The name of the resource group. The name is case insensitive.

workspace_name str

Name of Azure Machine Learning workspace.

id String

The name and identifier for the Job.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

Name of Azure Machine Learning workspace.

getJob Result

The following output properties are available:

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Properties Pulumi.AzureNative.MachineLearningServices.Outputs.CommandJobResponse | Pulumi.AzureNative.MachineLearningServices.Outputs.SweepJobResponse

[Required] Additional attributes of the entity.

SystemData Pulumi.AzureNative.MachineLearningServices.Outputs.SystemDataResponse

System data associated with resource provider

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Properties CommandJobResponse | SweepJobResponse

[Required] Additional attributes of the entity.

SystemData SystemDataResponse

System data associated with resource provider

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

properties CommandJobResponse | SweepJobResponse

[Required] Additional attributes of the entity.

systemData SystemDataResponse

System data associated with resource provider

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name string

The name of the resource

properties CommandJobResponse | SweepJobResponse

[Required] Additional attributes of the entity.

systemData SystemDataResponse

System data associated with resource provider

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name str

The name of the resource

properties CommandJobResponse | SweepJobResponse

[Required] Additional attributes of the entity.

system_data SystemDataResponse

System data associated with resource provider

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

properties Property Map | Property Map

[Required] Additional attributes of the entity.

systemData Property Map

System data associated with resource provider

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AmlTokenResponse

BanditPolicyResponse

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

SlackAmount double

Absolute distance allowed from the best performing run.

SlackFactor double

Ratio of the allowed distance from the best performing run.

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

SlackAmount float64

Absolute distance allowed from the best performing run.

SlackFactor float64

Ratio of the allowed distance from the best performing run.

delayEvaluation Integer

Number of intervals by which to delay the first evaluation.

evaluationInterval Integer

Interval (number of runs) between policy evaluations.

slackAmount Double

Absolute distance allowed from the best performing run.

slackFactor Double

Ratio of the allowed distance from the best performing run.

delayEvaluation number

Number of intervals by which to delay the first evaluation.

evaluationInterval number

Interval (number of runs) between policy evaluations.

slackAmount number

Absolute distance allowed from the best performing run.

slackFactor number

Ratio of the allowed distance from the best performing run.

delay_evaluation int

Number of intervals by which to delay the first evaluation.

evaluation_interval int

Interval (number of runs) between policy evaluations.

slack_amount float

Absolute distance allowed from the best performing run.

slack_factor float

Ratio of the allowed distance from the best performing run.

delayEvaluation Number

Number of intervals by which to delay the first evaluation.

evaluationInterval Number

Interval (number of runs) between policy evaluations.

slackAmount Number

Absolute distance allowed from the best performing run.

slackFactor Number

Ratio of the allowed distance from the best performing run.

CommandJobResponse

Command string

[Required] The command to execute on startup of the job. eg. "python train.py"

Compute Pulumi.AzureNative.MachineLearningServices.Inputs.ComputeConfigurationResponse

[Required] Compute binding for the job.

InteractionEndpoints Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.JobEndpointResponse>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Output Pulumi.AzureNative.MachineLearningServices.Inputs.JobOutputResponse

Location of the job output logs and artifacts.

Parameters object

Input parameters.

ProvisioningState string

Specifies the job provisioning state.

Status string

Status of the job.

CodeId string

ARM resource ID of the code asset.

Description string

The asset description text.

Distribution Pulumi.AzureNative.MachineLearningServices.Inputs.MpiResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.PyTorchResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

EnvironmentId string

The ARM resource ID of the Environment specification for the job.

EnvironmentVariables Dictionary<string, string>

Environment variables included in the job.

ExperimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

Identity Pulumi.AzureNative.MachineLearningServices.Inputs.AmlTokenResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

InputDataBindings Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.InputDataBindingResponse>

Mapping of input data bindings used in the job.

OutputDataBindings Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.OutputDataBindingResponse>

Mapping of output data bindings used in the job.

Priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

Properties Dictionary<string, string>

The asset property dictionary.

Tags Dictionary<string, string>

Tag dictionary. Tags can be added, removed, and updated.

Timeout string

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

Command string

[Required] The command to execute on startup of the job. eg. "python train.py"

Compute ComputeConfigurationResponse

[Required] Compute binding for the job.

InteractionEndpoints map[string]JobEndpointResponse

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Output JobOutputResponse

Location of the job output logs and artifacts.

Parameters interface{}

Input parameters.

ProvisioningState string

Specifies the job provisioning state.

Status string

Status of the job.

CodeId string

ARM resource ID of the code asset.

Description string

The asset description text.

Distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

EnvironmentId string

The ARM resource ID of the Environment specification for the job.

EnvironmentVariables map[string]string

Environment variables included in the job.

ExperimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

Identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

InputDataBindings map[string]InputDataBindingResponse

Mapping of input data bindings used in the job.

OutputDataBindings map[string]OutputDataBindingResponse

Mapping of output data bindings used in the job.

Priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

Properties map[string]string

The asset property dictionary.

Tags map[string]string

Tag dictionary. Tags can be added, removed, and updated.

Timeout string

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

command String

[Required] The command to execute on startup of the job. eg. "python train.py"

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interactionEndpoints Map<String,JobEndpointResponse>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

output JobOutputResponse

Location of the job output logs and artifacts.

parameters Object

Input parameters.

provisioningState String

Specifies the job provisioning state.

status String

Status of the job.

codeId String

ARM resource ID of the code asset.

description String

The asset description text.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId String

The ARM resource ID of the Environment specification for the job.

environmentVariables Map<String,String>

Environment variables included in the job.

experimentName String

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

inputDataBindings Map<String,InputDataBindingResponse>

Mapping of input data bindings used in the job.

outputDataBindings Map<String,OutputDataBindingResponse>

Mapping of output data bindings used in the job.

priority Integer

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Map<String,String>

The asset property dictionary.

tags Map<String,String>

Tag dictionary. Tags can be added, removed, and updated.

timeout String

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

command string

[Required] The command to execute on startup of the job. eg. "python train.py"

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interactionEndpoints {[key: string]: JobEndpointResponse}

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

output JobOutputResponse

Location of the job output logs and artifacts.

parameters any

Input parameters.

provisioningState string

Specifies the job provisioning state.

status string

Status of the job.

codeId string

ARM resource ID of the code asset.

description string

The asset description text.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId string

The ARM resource ID of the Environment specification for the job.

environmentVariables {[key: string]: string}

Environment variables included in the job.

experimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

inputDataBindings {[key: string]: InputDataBindingResponse}

Mapping of input data bindings used in the job.

outputDataBindings {[key: string]: OutputDataBindingResponse}

Mapping of output data bindings used in the job.

priority number

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties {[key: string]: string}

The asset property dictionary.

tags {[key: string]: string}

Tag dictionary. Tags can be added, removed, and updated.

timeout string

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

command str

[Required] The command to execute on startup of the job. eg. "python train.py"

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interaction_endpoints Mapping[str, JobEndpointResponse]

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

output JobOutputResponse

Location of the job output logs and artifacts.

parameters Any

Input parameters.

provisioning_state str

Specifies the job provisioning state.

status str

Status of the job.

code_id str

ARM resource ID of the code asset.

description str

The asset description text.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environment_id str

The ARM resource ID of the Environment specification for the job.

environment_variables Mapping[str, str]

Environment variables included in the job.

experiment_name str

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

input_data_bindings Mapping[str, InputDataBindingResponse]

Mapping of input data bindings used in the job.

output_data_bindings Mapping[str, OutputDataBindingResponse]

Mapping of output data bindings used in the job.

priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Mapping[str, str]

The asset property dictionary.

tags Mapping[str, str]

Tag dictionary. Tags can be added, removed, and updated.

timeout str

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

command String

[Required] The command to execute on startup of the job. eg. "python train.py"

compute Property Map

[Required] Compute binding for the job.

interactionEndpoints Map<Property Map>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

output Property Map

Location of the job output logs and artifacts.

parameters Any

Input parameters.

provisioningState String

Specifies the job provisioning state.

status String

Status of the job.

codeId String

ARM resource ID of the code asset.

description String

The asset description text.

distribution Property Map | Property Map | Property Map

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId String

The ARM resource ID of the Environment specification for the job.

environmentVariables Map<String>

Environment variables included in the job.

experimentName String

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity Property Map | Property Map

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null. Defaults to AmlToken if null.

inputDataBindings Map<Property Map>

Mapping of input data bindings used in the job.

outputDataBindings Map<Property Map>

Mapping of output data bindings used in the job.

priority Number

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Map<String>

The asset property dictionary.

tags Map<String>

Tag dictionary. Tags can be added, removed, and updated.

timeout String

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

ComputeConfigurationResponse

InstanceCount int

Number of instances or nodes.

InstanceType string

SKU type to run on.

IsLocal bool

Set to true for jobs running on local compute.

Location string

Location for virtual cluster run.

Properties Dictionary<string, string>

Additional properties.

Target string

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

InstanceCount int

Number of instances or nodes.

InstanceType string

SKU type to run on.

IsLocal bool

Set to true for jobs running on local compute.

Location string

Location for virtual cluster run.

Properties map[string]string

Additional properties.

Target string

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

instanceCount Integer

Number of instances or nodes.

instanceType String

SKU type to run on.

isLocal Boolean

Set to true for jobs running on local compute.

location String

Location for virtual cluster run.

properties Map<String,String>

Additional properties.

target String

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

instanceCount number

Number of instances or nodes.

instanceType string

SKU type to run on.

isLocal boolean

Set to true for jobs running on local compute.

location string

Location for virtual cluster run.

properties {[key: string]: string}

Additional properties.

target string

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

instance_count int

Number of instances or nodes.

instance_type str

SKU type to run on.

is_local bool

Set to true for jobs running on local compute.

location str

Location for virtual cluster run.

properties Mapping[str, str]

Additional properties.

target str

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

instanceCount Number

Number of instances or nodes.

instanceType String

SKU type to run on.

isLocal Boolean

Set to true for jobs running on local compute.

location String

Location for virtual cluster run.

properties Map<String>

Additional properties.

target String

ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.

InputDataBindingResponse

DataId string

ARM resource ID of the registered dataVersion.

Mode string

Mechanism for accessing the data artifact.

PathOnCompute string

Location of data inside the container process.

DataId string

ARM resource ID of the registered dataVersion.

Mode string

Mechanism for accessing the data artifact.

PathOnCompute string

Location of data inside the container process.

dataId String

ARM resource ID of the registered dataVersion.

mode String

Mechanism for accessing the data artifact.

pathOnCompute String

Location of data inside the container process.

dataId string

ARM resource ID of the registered dataVersion.

mode string

Mechanism for accessing the data artifact.

pathOnCompute string

Location of data inside the container process.

data_id str

ARM resource ID of the registered dataVersion.

mode str

Mechanism for accessing the data artifact.

path_on_compute str

Location of data inside the container process.

dataId String

ARM resource ID of the registered dataVersion.

mode String

Mechanism for accessing the data artifact.

pathOnCompute String

Location of data inside the container process.

JobEndpointResponse

Endpoint string

Url for endpoint.

JobEndpointType string

Endpoint type.

Port int

Port for endpoint.

Properties Dictionary<string, string>

Additional properties to set on the endpoint.

Endpoint string

Url for endpoint.

JobEndpointType string

Endpoint type.

Port int

Port for endpoint.

Properties map[string]string

Additional properties to set on the endpoint.

endpoint String

Url for endpoint.

jobEndpointType String

Endpoint type.

port Integer

Port for endpoint.

properties Map<String,String>

Additional properties to set on the endpoint.

endpoint string

Url for endpoint.

jobEndpointType string

Endpoint type.

port number

Port for endpoint.

properties {[key: string]: string}

Additional properties to set on the endpoint.

endpoint str

Url for endpoint.

job_endpoint_type str

Endpoint type.

port int

Port for endpoint.

properties Mapping[str, str]

Additional properties to set on the endpoint.

endpoint String

Url for endpoint.

jobEndpointType String

Endpoint type.

port Number

Port for endpoint.

properties Map<String>

Additional properties to set on the endpoint.

JobOutputResponse

DatastoreId string

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

Path string

Path within the datastore to the job logs and artifacts.

DatastoreId string

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

Path string

Path within the datastore to the job logs and artifacts.

datastoreId String

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

path String

Path within the datastore to the job logs and artifacts.

datastoreId string

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

path string

Path within the datastore to the job logs and artifacts.

datastore_id str

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

path str

Path within the datastore to the job logs and artifacts.

datastoreId String

ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account.

path String

Path within the datastore to the job logs and artifacts.

ManagedIdentityResponse

ClientId string

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

ObjectId string

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

ResourceId string

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

ClientId string

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

ObjectId string

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

ResourceId string

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

clientId String

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

objectId String

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

resourceId String

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

clientId string

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

objectId string

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

resourceId string

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

client_id str

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

object_id str

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

resource_id str

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

clientId String

Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.

objectId String

Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.

resourceId String

Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.

MedianStoppingPolicyResponse

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

delayEvaluation Integer

Number of intervals by which to delay the first evaluation.

evaluationInterval Integer

Interval (number of runs) between policy evaluations.

delayEvaluation number

Number of intervals by which to delay the first evaluation.

evaluationInterval number

Interval (number of runs) between policy evaluations.

delay_evaluation int

Number of intervals by which to delay the first evaluation.

evaluation_interval int

Interval (number of runs) between policy evaluations.

delayEvaluation Number

Number of intervals by which to delay the first evaluation.

evaluationInterval Number

Interval (number of runs) between policy evaluations.

MpiResponse

ProcessCountPerInstance int

Number of processes per MPI node.

ProcessCountPerInstance int

Number of processes per MPI node.

processCountPerInstance Integer

Number of processes per MPI node.

processCountPerInstance number

Number of processes per MPI node.

process_count_per_instance int

Number of processes per MPI node.

processCountPerInstance Number

Number of processes per MPI node.

ObjectiveResponse

Goal string

[Required] Defines supported metric goals for hyperparameter tuning

PrimaryMetric string

[Required] Name of the metric to optimize.

Goal string

[Required] Defines supported metric goals for hyperparameter tuning

PrimaryMetric string

[Required] Name of the metric to optimize.

goal String

[Required] Defines supported metric goals for hyperparameter tuning

primaryMetric String

[Required] Name of the metric to optimize.

goal string

[Required] Defines supported metric goals for hyperparameter tuning

primaryMetric string

[Required] Name of the metric to optimize.

goal str

[Required] Defines supported metric goals for hyperparameter tuning

primary_metric str

[Required] Name of the metric to optimize.

goal String

[Required] Defines supported metric goals for hyperparameter tuning

primaryMetric String

[Required] Name of the metric to optimize.

OutputDataBindingResponse

DatastoreId string

ARM resource ID of the datastore where the data output will be stored.

Mode string

Mechanism for data movement to datastore.

PathOnCompute string

Location of data inside the container process.

PathOnDatastore string

Path within the datastore to the data.

DatastoreId string

ARM resource ID of the datastore where the data output will be stored.

Mode string

Mechanism for data movement to datastore.

PathOnCompute string

Location of data inside the container process.

PathOnDatastore string

Path within the datastore to the data.

datastoreId String

ARM resource ID of the datastore where the data output will be stored.

mode String

Mechanism for data movement to datastore.

pathOnCompute String

Location of data inside the container process.

pathOnDatastore String

Path within the datastore to the data.

datastoreId string

ARM resource ID of the datastore where the data output will be stored.

mode string

Mechanism for data movement to datastore.

pathOnCompute string

Location of data inside the container process.

pathOnDatastore string

Path within the datastore to the data.

datastore_id str

ARM resource ID of the datastore where the data output will be stored.

mode str

Mechanism for data movement to datastore.

path_on_compute str

Location of data inside the container process.

path_on_datastore str

Path within the datastore to the data.

datastoreId String

ARM resource ID of the datastore where the data output will be stored.

mode String

Mechanism for data movement to datastore.

pathOnCompute String

Location of data inside the container process.

pathOnDatastore String

Path within the datastore to the data.

PyTorchResponse

ProcessCount int

Total process count for the distributed job.

ProcessCount int

Total process count for the distributed job.

processCount Integer

Total process count for the distributed job.

processCount number

Total process count for the distributed job.

process_count int

Total process count for the distributed job.

processCount Number

Total process count for the distributed job.

SweepJobResponse

Algorithm string

[Required] Type of the hyperparameter sampling algorithms

Compute Pulumi.AzureNative.MachineLearningServices.Inputs.ComputeConfigurationResponse

[Required] Compute binding for the job.

InteractionEndpoints Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.JobEndpointResponse>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Objective Pulumi.AzureNative.MachineLearningServices.Inputs.ObjectiveResponse

[Required] Optimization objective.

Output Pulumi.AzureNative.MachineLearningServices.Inputs.JobOutputResponse

Location of the job output logs and artifacts.

ProvisioningState string

Specifies the job provisioning state.

SearchSpace Dictionary<string, object>

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

Status string

The status of a job.

Description string

The asset description text.

EarlyTermination Pulumi.AzureNative.MachineLearningServices.Inputs.BanditPolicyResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.MedianStoppingPolicyResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.TruncationSelectionPolicyResponse

Early termination policies enable canceling poor-performing runs before they complete.

ExperimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

Identity Pulumi.AzureNative.MachineLearningServices.Inputs.AmlTokenResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

MaxConcurrentTrials int

An upper bound on the number of trials performed in parallel.

MaxTotalTrials int

An upper bound on the number of trials to perform.

Priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

Properties Dictionary<string, string>

The asset property dictionary.

Tags Dictionary<string, string>

Tag dictionary. Tags can be added, removed, and updated.

Timeout string

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

Trial Pulumi.AzureNative.MachineLearningServices.Inputs.TrialComponentResponse

Trial component definition.

Algorithm string

[Required] Type of the hyperparameter sampling algorithms

Compute ComputeConfigurationResponse

[Required] Compute binding for the job.

InteractionEndpoints map[string]JobEndpointResponse

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Objective ObjectiveResponse

[Required] Optimization objective.

Output JobOutputResponse

Location of the job output logs and artifacts.

ProvisioningState string

Specifies the job provisioning state.

SearchSpace map[string]interface{}

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

Status string

The status of a job.

Description string

The asset description text.

EarlyTermination BanditPolicyResponse | MedianStoppingPolicyResponse | TruncationSelectionPolicyResponse

Early termination policies enable canceling poor-performing runs before they complete.

ExperimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

Identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

MaxConcurrentTrials int

An upper bound on the number of trials performed in parallel.

MaxTotalTrials int

An upper bound on the number of trials to perform.

Priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

Properties map[string]string

The asset property dictionary.

Tags map[string]string

Tag dictionary. Tags can be added, removed, and updated.

Timeout string

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

Trial TrialComponentResponse

Trial component definition.

algorithm String

[Required] Type of the hyperparameter sampling algorithms

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interactionEndpoints Map<String,JobEndpointResponse>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

objective ObjectiveResponse

[Required] Optimization objective.

output JobOutputResponse

Location of the job output logs and artifacts.

provisioningState String

Specifies the job provisioning state.

searchSpace Map<String,Object>

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

status String

The status of a job.

description String

The asset description text.

earlyTermination BanditPolicyResponse | MedianStoppingPolicyResponse | TruncationSelectionPolicyResponse

Early termination policies enable canceling poor-performing runs before they complete.

experimentName String

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

maxConcurrentTrials Integer

An upper bound on the number of trials performed in parallel.

maxTotalTrials Integer

An upper bound on the number of trials to perform.

priority Integer

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Map<String,String>

The asset property dictionary.

tags Map<String,String>

Tag dictionary. Tags can be added, removed, and updated.

timeout String

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

trial TrialComponentResponse

Trial component definition.

algorithm string

[Required] Type of the hyperparameter sampling algorithms

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interactionEndpoints {[key: string]: JobEndpointResponse}

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

objective ObjectiveResponse

[Required] Optimization objective.

output JobOutputResponse

Location of the job output logs and artifacts.

provisioningState string

Specifies the job provisioning state.

searchSpace {[key: string]: any}

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

status string

The status of a job.

description string

The asset description text.

earlyTermination BanditPolicyResponse | MedianStoppingPolicyResponse | TruncationSelectionPolicyResponse

Early termination policies enable canceling poor-performing runs before they complete.

experimentName string

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

maxConcurrentTrials number

An upper bound on the number of trials performed in parallel.

maxTotalTrials number

An upper bound on the number of trials to perform.

priority number

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties {[key: string]: string}

The asset property dictionary.

tags {[key: string]: string}

Tag dictionary. Tags can be added, removed, and updated.

timeout string

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

trial TrialComponentResponse

Trial component definition.

algorithm str

[Required] Type of the hyperparameter sampling algorithms

compute ComputeConfigurationResponse

[Required] Compute binding for the job.

interaction_endpoints Mapping[str, JobEndpointResponse]

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

objective ObjectiveResponse

[Required] Optimization objective.

output JobOutputResponse

Location of the job output logs and artifacts.

provisioning_state str

Specifies the job provisioning state.

search_space Mapping[str, Any]

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

status str

The status of a job.

description str

The asset description text.

early_termination BanditPolicyResponse | MedianStoppingPolicyResponse | TruncationSelectionPolicyResponse

Early termination policies enable canceling poor-performing runs before they complete.

experiment_name str

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity AmlTokenResponse | ManagedIdentityResponse

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

max_concurrent_trials int

An upper bound on the number of trials performed in parallel.

max_total_trials int

An upper bound on the number of trials to perform.

priority int

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Mapping[str, str]

The asset property dictionary.

tags Mapping[str, str]

Tag dictionary. Tags can be added, removed, and updated.

timeout str

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

trial TrialComponentResponse

Trial component definition.

algorithm String

[Required] Type of the hyperparameter sampling algorithms

compute Property Map

[Required] Compute binding for the job.

interactionEndpoints Map<Property Map>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

objective Property Map

[Required] Optimization objective.

output Property Map

Location of the job output logs and artifacts.

provisioningState String

Specifies the job provisioning state.

searchSpace Map<Any>

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter

status String

The status of a job.

description String

The asset description text.

earlyTermination Property Map | Property Map | Property Map

Early termination policies enable canceling poor-performing runs before they complete.

experimentName String

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity Property Map | Property Map

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null. Defaults to AmlToken if null.

maxConcurrentTrials Number

An upper bound on the number of trials performed in parallel.

maxTotalTrials Number

An upper bound on the number of trials to perform.

priority Number

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

properties Map<String>

The asset property dictionary.

tags Map<String>

Tag dictionary. Tags can be added, removed, and updated.

timeout String

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

trial Property Map

Trial component definition.

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC)

CreatedBy string

An identifier for the identity that created the resource

CreatedByType string

The type of identity that created the resource

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

An identifier for the identity that last modified the resource

LastModifiedByType string

The type of identity that last modified the resource

CreatedAt string

The timestamp of resource creation (UTC)

CreatedBy string

An identifier for the identity that created the resource

CreatedByType string

The type of identity that created the resource

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

An identifier for the identity that last modified the resource

LastModifiedByType string

The type of identity that last modified the resource

createdAt String

The timestamp of resource creation (UTC)

createdBy String

An identifier for the identity that created the resource

createdByType String

The type of identity that created the resource

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

An identifier for the identity that last modified the resource

lastModifiedByType String

The type of identity that last modified the resource

createdAt string

The timestamp of resource creation (UTC)

createdBy string

An identifier for the identity that created the resource

createdByType string

The type of identity that created the resource

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

An identifier for the identity that last modified the resource

lastModifiedByType string

The type of identity that last modified the resource

created_at str

The timestamp of resource creation (UTC)

created_by str

An identifier for the identity that created the resource

created_by_type str

The type of identity that created the resource

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

An identifier for the identity that last modified the resource

last_modified_by_type str

The type of identity that last modified the resource

createdAt String

The timestamp of resource creation (UTC)

createdBy String

An identifier for the identity that created the resource

createdByType String

The type of identity that created the resource

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

An identifier for the identity that last modified the resource

lastModifiedByType String

The type of identity that last modified the resource

TensorFlowResponse

ParameterServerCount int

Number of parameter server tasks.

WorkerCount int

Number of workers. Overwrites the node count in compute binding.

ParameterServerCount int

Number of parameter server tasks.

WorkerCount int

Number of workers. Overwrites the node count in compute binding.

parameterServerCount Integer

Number of parameter server tasks.

workerCount Integer

Number of workers. Overwrites the node count in compute binding.

parameterServerCount number

Number of parameter server tasks.

workerCount number

Number of workers. Overwrites the node count in compute binding.

parameter_server_count int

Number of parameter server tasks.

worker_count int

Number of workers. Overwrites the node count in compute binding.

parameterServerCount Number

Number of parameter server tasks.

workerCount Number

Number of workers. Overwrites the node count in compute binding.

TrialComponentResponse

Command string

[Required] The command to execute on startup of the job. eg. "python train.py"

CodeId string

ARM resource ID of the code asset.

Distribution Pulumi.AzureNative.MachineLearningServices.Inputs.MpiResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.PyTorchResponse | Pulumi.AzureNative.MachineLearningServices.Inputs.TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

EnvironmentId string

The ARM resource ID of the Environment specification for the job.

EnvironmentVariables Dictionary<string, string>

Environment variables included in the job.

InputDataBindings Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.InputDataBindingResponse>

Mapping of input data bindings used in the job.

OutputDataBindings Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.OutputDataBindingResponse>

Mapping of output data bindings used in the job.

Timeout string

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

Command string

[Required] The command to execute on startup of the job. eg. "python train.py"

CodeId string

ARM resource ID of the code asset.

Distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

EnvironmentId string

The ARM resource ID of the Environment specification for the job.

EnvironmentVariables map[string]string

Environment variables included in the job.

InputDataBindings map[string]InputDataBindingResponse

Mapping of input data bindings used in the job.

OutputDataBindings map[string]OutputDataBindingResponse

Mapping of output data bindings used in the job.

Timeout string

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

command String

[Required] The command to execute on startup of the job. eg. "python train.py"

codeId String

ARM resource ID of the code asset.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId String

The ARM resource ID of the Environment specification for the job.

environmentVariables Map<String,String>

Environment variables included in the job.

inputDataBindings Map<String,InputDataBindingResponse>

Mapping of input data bindings used in the job.

outputDataBindings Map<String,OutputDataBindingResponse>

Mapping of output data bindings used in the job.

timeout String

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

command string

[Required] The command to execute on startup of the job. eg. "python train.py"

codeId string

ARM resource ID of the code asset.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId string

The ARM resource ID of the Environment specification for the job.

environmentVariables {[key: string]: string}

Environment variables included in the job.

inputDataBindings {[key: string]: InputDataBindingResponse}

Mapping of input data bindings used in the job.

outputDataBindings {[key: string]: OutputDataBindingResponse}

Mapping of output data bindings used in the job.

timeout string

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

command str

[Required] The command to execute on startup of the job. eg. "python train.py"

code_id str

ARM resource ID of the code asset.

distribution MpiResponse | PyTorchResponse | TensorFlowResponse

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environment_id str

The ARM resource ID of the Environment specification for the job.

environment_variables Mapping[str, str]

Environment variables included in the job.

input_data_bindings Mapping[str, InputDataBindingResponse]

Mapping of input data bindings used in the job.

output_data_bindings Mapping[str, OutputDataBindingResponse]

Mapping of output data bindings used in the job.

timeout str

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

command String

[Required] The command to execute on startup of the job. eg. "python train.py"

codeId String

ARM resource ID of the code asset.

distribution Property Map | Property Map | Property Map

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

environmentId String

The ARM resource ID of the Environment specification for the job.

environmentVariables Map<String>

Environment variables included in the job.

inputDataBindings Map<Property Map>

Mapping of input data bindings used in the job.

outputDataBindings Map<Property Map>

Mapping of output data bindings used in the job.

timeout String

The max run duration in ISO 8601 format, after which the trial component will be cancelled. Only supports duration with precision as low as Seconds.

TruncationSelectionPolicyResponse

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

TruncationPercentage int

The percentage of runs to cancel at each evaluation interval.

DelayEvaluation int

Number of intervals by which to delay the first evaluation.

EvaluationInterval int

Interval (number of runs) between policy evaluations.

TruncationPercentage int

The percentage of runs to cancel at each evaluation interval.

delayEvaluation Integer

Number of intervals by which to delay the first evaluation.

evaluationInterval Integer

Interval (number of runs) between policy evaluations.

truncationPercentage Integer

The percentage of runs to cancel at each evaluation interval.

delayEvaluation number

Number of intervals by which to delay the first evaluation.

evaluationInterval number

Interval (number of runs) between policy evaluations.

truncationPercentage number

The percentage of runs to cancel at each evaluation interval.

delay_evaluation int

Number of intervals by which to delay the first evaluation.

evaluation_interval int

Interval (number of runs) between policy evaluations.

truncation_percentage int

The percentage of runs to cancel at each evaluation interval.

delayEvaluation Number

Number of intervals by which to delay the first evaluation.

evaluationInterval Number

Interval (number of runs) between policy evaluations.

truncationPercentage Number

The percentage of runs to cancel at each evaluation interval.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0