Share via

OnlineDeployment Class

  • Reference

Online endpoint deployment entity.

Online endpoint deployment entity.

Constructor for Online endpoint deployment entity

Inheritance
azure.ai.ml.entities._deployment.deployment.Deployment
OnlineDeployment

Constructor

OnlineDeployment(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, data_collector: DataCollector | None = None, code_configuration: CodeConfiguration | None = None, environment: str | Environment | None = None, app_insights_enabled: bool | None = False, scale_settings: OnlineScaleSettings | 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_count: int | None = None, instance_type: str | None = None, model_mount_path: str | None = None, code_path: str | PathLike | None = None, scoring_script: str | PathLike | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the deployment resource.
name
Required
str

Name of the deployment resource.

Keyword-Only Parameters

Name Description
endpoint_name
Optional[str]

Name of the endpoint resource, defaults to None
tags
Optional[Dict[str, Any]]

Tag dictionary. Tags can be added, removed, and updated, defaults to None
properties
Optional[Dict[str, Any]]

The asset property dictionary, defaults to None
description
Optional[str]

Description of the resource, defaults to None
model
Optional[Union[str, Model]]

Model entity for the endpoint deployment, defaults to None
data_collector
Optional[Union[str, DataCollector]]

Data Collector entity for the endpoint deployment, defaults to None
code_configuration
Optional[CodeConfiguration]

Code Configuration, defaults to None
environment
Optional[Union[str, Environment]]

Environment entity for the endpoint deployment, defaults to None
app_insights_enabled
Optional[bool]

Is appinsights enabled, defaults to False
scale_settings
Optional[OnlineScaleSettings]

How the online deployment will scale, defaults to None
request_settings
Optional[OnlineRequestSettings]

Online Request Settings, defaults to None
liveness_probe
Optional[ProbeSettings]

Liveness probe settings, defaults to None
readiness_probe
Optional[ProbeSettings]

Readiness probe settings, defaults to None
environment_variables
Optional[Dict[str, str]]

Environment variables that will be set in deployment, defaults to None
instance_count
Optional[int]

The instance count used for this deployment, defaults to None
instance_type
Optional[str]

Azure compute sku, defaults to None
model_mount_path
Optional[str]

The path to mount the model in custom container, defaults to None
code_path
Optional[Union[str, PathLike]]

Equivalent to code_configuration.code, will be ignored if code_configuration is present , defaults to None
scoring_script
Optional[Union[str, PathLike]]

Equivalent to code_configuration.code.scoring_script. Will be ignored if code_configuration is present, defaults to None
endpoint_name
Optional[str]

Name of the endpoint resource, defaults to None
tags
Optional[Dict[str, Any]]

Tag dictionary. Tags can be added, removed, and updated, defaults to None
properties
Optional[Dict[str, Any]]

The asset property dictionary, defaults to None
description
Optional[str]

Description of the resource, defaults to None
model
Optional[Union[str, Model]]

Model entity for the endpoint deployment, defaults to None
code_configuration
Optional[CodeConfiguration]

Code Configuration, defaults to None
environment
Optional[Union[str, Environment]]

Environment entity for the endpoint deployment, defaults to None
app_insights_enabled
Optional[bool]

Is appinsights enabled, defaults to False
scale_settings
Optional[OnlineScaleSettings]

How the online deployment will scale, defaults to None
request_settings
Optional[OnlineRequestSettings]

Online Request Settings, defaults to None
liveness_probe
Optional[ProbeSettings]

Liveness probe settings, defaults to None
readiness_probe
Optional[ProbeSettings]

Readiness probe settings, defaults to None
environment_variables
Optional[Dict[str, str]]

Environment variables that will be set in deployment, defaults to None
instance_count
Optional[int]

The instance count used for this deployment, defaults to None
instance_type
Optional[str]

Azure compute sku, defaults to None
model_mount_path
Optional[str]

The path to mount the model in custom container, defaults to None
code_path
Optional[Union[str, PathLike]]

Equivalent to code_configuration.code, will be ignored if code_configuration is present , defaults to None
scoring_script
Optional[Union[str, PathLike]]

Equivalent to code_configuration.code.scoring_script. Will be ignored if code_configuration is present, defaults to None

Methods

dump

Dump the deployment content into a file in yaml format.

dump

Dump the deployment content into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[PathLike, str, IO[AnyStr]]

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.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

code_path

The code directory containing the scoring script.

Returns

Type Description
Union[str, <xref:PathLike>]

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

provisioning_state

Deployment provisioning state, readonly.

Returns

Type Description
Optional[str]

Deployment provisioning state.

scoring_script

The scoring script file path relative to the code directory.

Returns

Type Description
Union[str, <xref:PathLike>]

type

Type of deployment.

Returns

Type Description
str