OnlineDeployment Class
Online endpoint deployment entity.
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
|
Name of the deployment resource. |
endpoint_name
Required
|
Name of the endpoint resource, defaults to None |
tags
Required
|
Tag dictionary. Tags can be added, removed, and updated, defaults to None |
properties
Required
|
The asset property dictionary, defaults to None |
description
Required
|
Description of the resource, defaults to None |
model
Required
|
Model entity for the endpoint deployment, defaults to None |
data_collector
Required
|
Data Collector entity for the endpoint deployment, defaults to None |
code_configuration
Required
|
Code Configuration, defaults to None |
environment
Required
|
Environment entity for the endpoint deployment, defaults to None |
app_insights_enabled
Required
|
Is appinsights enabled, defaults to False |
scale_settings
Required
|
How the online deployment will scale, defaults to None |
request_settings
Required
|
Online Request Settings, defaults to None |
liveness_probe
Required
|
Liveness probe settings, defaults to None |
readiness_probe
Required
|
Readiness probe settings, defaults to None |
environment_variables
Required
|
Environment variables that will be set in deployment, defaults to None |
instance_count
Required
|
The instance count used for this deployment, defaults to None |
instance_type
Required
|
Azure compute sku, defaults to None |
model_mount_path
Required
|
The path to mount the model in custom container, defaults to None |
code_path
Required
|
Equivalent to code_configuration.code, will be ignored if code_configuration is present , defaults to None |
scoring_script
Required
|
Equivalent to code_configuration.code.scoring_script. Will be ignored if code_configuration is present, defaults to None |
Keyword-Only Parameters
Name | Description |
---|---|
endpoint_name
Required
|
|
tags
Required
|
|
properties
Required
|
|
description
Required
|
|
model
Required
|
|
data_collector
Required
|
|
code_configuration
Required
|
|
environment
Required
|
|
app_insights_enabled
Required
|
|
scale_settings
Required
|
|
request_settings
Required
|
|
liveness_probe
Required
|
|
readiness_probe
Required
|
|
environment_variables
Required
|
|
instance_count
Required
|
|
instance_type
Required
|
|
model_mount_path
Required
|
|
code_path
Required
|
|
scoring_script
Required
|
|
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
|
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
code_path
creation_context
The creation context of the resource.
Returns
Type | Description |
---|---|
The creation metadata for the resource. |
id
provisioning_state
scoring_script
type
Azure SDK for Python