azure.ai.ml.entities.ParameterizedCommand.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.ParameterizedCommand
name: ParameterizedCommand
fullName: azure.ai.ml.entities.ParameterizedCommand
module: azure.ai.ml.entities
inheritances:
- builtins.object
summary: 'Command component version that contains the command and supporting parameters
  for a Command component

  or job.


  This class should not be instantiated directly. Instead, use the child class

  ~azure.ai.ml.entities.CommandComponent.'
constructor:
  syntax: 'ParameterizedCommand(command: str | None = '''', resources: dict | JobResourceConfiguration
    | None = None, code: PathLike | str | None = None, environment_variables: Dict
    | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution |
    PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None,
    environment: Environment | str | None = None, queue_settings: QueueSettings |
    None = None, **kwargs: Dict)'
  parameters:
  - name: command
    description: The command to be executed. Defaults to "".
    isRequired: true
    types:
    - <xref:str>
  - name: resources
    description: The compute resource configuration for the command.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:dict>, <xref:azure.ai.ml.entities.JobResourceConfiguration>]]
  - name: code
    description: 'The source code to run the job. Can be a local path or "http:",
      "https:", or "azureml:" url pointing

      to a remote location.'
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: environment_variables
    description: 'A dictionary of environment variable names and values.

      These environment variables are set on the process where user script is being
      executed.'
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:str>]]
  - name: distribution
    description: The distribution configuration for distributed jobs.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:dict>, <xref:azure.ai.ml.PyTorchDistribution>,
      <xref:azure.ai.ml.MpiDistribution>, <xref:azure.ai.ml.TensorFlowDistribution>,
      <xref:azure.ai.ml.RayDistribution>]]
  - name: environment
    description: The environment that the job will run in.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.entities.Environment>]]
  - name: queue_settings
    description: The queue settings for the job.
    defaultValue: None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.QueueSettings>]
  keywordOnlyParameters:
  - name: kwargs
    description: A dictionary of additional configuration parameters.
    types:
    - <xref:dict>
attributes:
- uid: azure.ai.ml.entities.ParameterizedCommand.distribution
  name: distribution
  summary: The configuration for the distributed command component or job.
  return:
    description: The distribution configuration.
    types:
    - <xref:typing.Union>[<xref:azure.ai.ml.PyTorchDistribution>, <xref:azure.ai.ml.MpiDistribution>,
      <xref:azure.ai.ml.TensorFlowDistribution>, <xref:azure.ai.ml.RayDistribution>]
- uid: azure.ai.ml.entities.ParameterizedCommand.resources
  name: resources
  summary: The compute resource configuration for the command component or job.
  return:
    description: The compute resource configuration for the command component or job.
    types:
    - <xref:azure.ai.ml.entities.JobResourceConfiguration>