azure.ai.ml.entities.ManagedOnlineDeployment.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.ManagedOnlineDeployment
name: ManagedOnlineDeployment
fullName: azure.ai.ml.entities.ManagedOnlineDeployment
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._deployment.online_deployment.OnlineDeployment
summary: 'Managed Online endpoint deployment entity.


  Managed Online endpoint deployment entity.


  Constructor for Managed Online endpoint deployment entity.'
constructor:
  syntax: 'ManagedOnlineDeployment(*, name: str, endpoint_name: str | None = None,
    tags: Dict[str, Any] | None = None, properties: Dict[str, Any] | None = None,
    description: str | None = None, model: str | Model | None = None, code_configuration:
    CodeConfiguration | None = None, environment: str | Environment | None = None,
    app_insights_enabled: bool = False, scale_settings: DefaultScaleSettings | TargetUtilizationScaleSettings
    | None = None, request_settings: OnlineRequestSettings | None = None, liveness_probe:
    ProbeSettings | None = None, readiness_probe: ProbeSettings | None = None, environment_variables:
    Dict[str, str] | None = None, instance_type: str | None = None, instance_count:
    int | None = None, egress_public_network_access: str | None = None, code_path:
    PathLike | str | None = None, scoring_script: PathLike | str | None = None, data_collector:
    DataCollector | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: name
    description: Name of the deployment resource
    types:
    - <xref:str>
  - name: endpoint_name
    description: Name of the endpoint resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: tags
    description: Tag dictionary. Tags can be added, removed, and updated., defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: properties
    description: The asset property dictionary, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: description
    description: Description of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: model
    description: Model entity for the endpoint deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.entities.Model>]]
  - name: code_configuration
    description: Code Configuration, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.CodeConfiguration>]
  - name: environment
    description: Environment entity for the endpoint deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.entities.Environment>]]
  - name: app_insights_enabled
    description: Is appinsights enabled, defaults to False
    types:
    - <xref:bool>
  - name: scale_settings
    description: How the online deployment will scale, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:azure.ai.ml.entities.DefaultScaleSettings>
      , <xref:azure.ai.ml.entities.TargetUtilizationScaleSettings>]]
  - name: request_settings
    description: Online Request Settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.OnlineRequestSettings>]
  - name: liveness_probe
    description: Liveness probe settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.ProbeSettings>]
  - name: readiness_probe
    description: Readiness probe settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.ProbeSettings>]
  - name: environment_variables
    description: Environment variables that will be set in deployment, defaults to
      None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:str>]]
  - name: instance_type
    description: Azure compute sku, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: instance_count
    description: The instance count used for this deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: egress_public_network_access
    description: 'Whether to restrict communication between a deployment and the

      Azure resources used to by the deployment. Allowed values are: "enabled", "disabled",
      defaults to None'
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: code_path
    description: 'Equivalent to code_configuration.code, will be ignored if code_configuration
      is present

      , defaults to None'
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:os.PathLike>]]
  - name: scoring_script_path
    description: 'Equivalent to code_configuration.scoring_script, will be ignored
      if

      code_configuration is present, defaults to None'
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:os.PathLike>]]
  - name: data_collector
    description: Data collector, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.List>[<xref:azure.ai.ml.entities.DataCollector>]]
  - name: name
    description: Name of the deployment resource
    types:
    - <xref:str>
  - name: endpoint_name
    description: Name of the endpoint resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: tags
    description: Tag dictionary. Tags can be added, removed, and updated., defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: properties
    description: The asset property dictionary, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: description
    description: Description of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: model
    description: Model entity for the endpoint deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.entities.Model>]]
  - name: code_configuration
    description: Code Configuration, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.CodeConfiguration>]
  - name: environment
    description: Environment entity for the endpoint deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.entities.Environment>]]
  - name: app_insights_enabled
    description: Is appinsights enabled, defaults to False
    types:
    - <xref:bool>
  - name: scale_settings
    description: How the online deployment will scale, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:azure.ai.ml.entities.DefaultScaleSettings>
      , <xref:azure.ai.ml.entities.TargetUtilizationScaleSettings>]]
  - name: request_settings
    description: Online Request Settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.OnlineRequestSettings>]
  - name: liveness_probe
    description: Liveness probe settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.ProbeSettings>]
  - name: readiness_probe
    description: Readiness probe settings, defaults to None
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.ProbeSettings>]
  - name: environment_variables
    description: Environment variables that will be set in deployment, defaults to
      None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:str>]]
  - name: instance_type
    description: Azure compute sku, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: instance_count
    description: The instance count used for this deployment, defaults to None
    types:
    - <xref:typing.Optional>[<xref:int>]
  - name: egress_public_network_access
    description: 'Whether to restrict communication between a deployment and the

      Azure resources used to by the deployment. Allowed values are: "enabled", "disabled",
      defaults to None'
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: code_path
    description: 'Equivalent to code_configuration.code, will be ignored if code_configuration
      is present

      , defaults to None'
    types:
    - <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:os.PathLike>]]
  - name: scoring_script
    isRequired: true
methods:
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.dump
  name: dump
  summary: Dump the deployment content into a file in yaml format.
  signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
  parameters:
  - name: dest
    description: 'The destination to receive this deployment''s content.

      Must be either a path to a local file, or an already-open file stream.

      If dest is a file path, a new file will be created,

      and an exception is raised if the file exists.

      If dest is an open file, the file will be written to directly,

      and an exception will be raised if the file is not writable.'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:os.PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
attributes:
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.base_path
  name: base_path
  summary: The base path of the resource.
  return:
    description: The base path of the resource.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.code_path
  name: code_path
  summary: The code directory containing the scoring script.
  return:
    types:
    - <xref:typing.Union>[<xref:str>, <xref:PathLike>]
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.creation_context
  name: creation_context
  summary: The creation context of the resource.
  return:
    description: The creation metadata for the resource.
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.id
  name: id
  summary: The resource ID.
  return:
    description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.provisioning_state
  name: provisioning_state
  summary: Deployment provisioning state, readonly.
  return:
    description: Deployment provisioning state.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.scoring_script
  name: scoring_script
  summary: The scoring script file path relative to the code directory.
  return:
    types:
    - <xref:typing.Union>[<xref:str>, <xref:PathLike>]
- uid: azure.ai.ml.entities.ManagedOnlineDeployment.type
  name: type
  summary: Type of deployment.
  return:
    types:
    - <xref:str>