DeploymentTemplate Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

DeploymentTemplate entity for Azure ML deployments.

Constructor

DeploymentTemplate(name: str, version: str, *, description: str | None = None, environment: str | Environment | None = None, request_settings: OnlineRequestSettings | None = None, liveness_probe: ProbeSettings | None = None, readiness_probe: ProbeSettings | None = None, instance_count: int | None = None, instance_type: str | None = None, model: str | None = None, code_configuration: Dict[str, Any] | None = None, environment_variables: Dict[str, str] | None = None, app_insights_enabled: bool | None = None, allowed_instance_type: str | None = None, default_instance_type: str | None = None, scoring_port: int | None = None, scoring_path: str | None = None, model_mount_path: str | None = None, type: str | None = None, deployment_template_type: str | None = None, stage: str | None = None, **kwargs)

Parameters

Name	Description
name Required	str Name of the deployment template.
version Required	str Version of the deployment template.
description Required	str Description of the deployment template.
environment Required	Environment Environment for the deployment template.
request_settings Required	OnlineRequestSettings Request settings for the deployment template.
liveness_probe Required	ProbeSettings Liveness probe settings.
readiness_probe Required	ProbeSettings Readiness probe settings.
instance_count Required	int Number of instances for the deployment template.
instance_type Required	str Instance type for the deployment template.
model Required	str Model for the deployment template.
code_configuration Required	dict Code configuration for the deployment template.
environment_variables Required	dict Environment variables for the deployment template.
app_insights_enabled Required	bool Whether application insights is enabled.
stage Required	str Stage of the deployment template. Can be "Active" or "Archived".

Keyword-Only Parameters

Name	Description
description	Default value: None
environment	Default value: None
request_settings	Default value: None
liveness_probe	Default value: None
readiness_probe	Default value: None
instance_count	Default value: None
instance_type	Default value: None
model	Default value: None
code_configuration	Default value: None
environment_variables	Default value: None
app_insights_enabled	Default value: None
allowed_instance_type	Default value: None
default_instance_type	Default value: None
scoring_port	Default value: None
scoring_path	Default value: None
model_mount_path	Default value: None
type	Default value: None
deployment_template_type	Default value: None
stage	Default value: None

Methods

dump	Dump the deployment template to a dictionary.

dump

Dump the deployment template to a dictionary.

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

Parameters

Name	Description
dest	Optional[Union[str, <xref:PathLike>]] Destination path to write the deployment template to. Default value: None

Returns

Type	Description
Dict[str, Any]	Dictionary representation of the deployment template.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

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.

liveness_probe_initial_delay

Get liveness probe initial delay in seconds.

liveness_probe_period

Get liveness probe period in seconds.

liveness_probe_timeout

Get liveness probe timeout in seconds.

readiness_probe_initial_delay

Get readiness probe initial delay in seconds.

readiness_probe_period

Get readiness probe period in seconds.

readiness_probe_timeout

Get readiness probe timeout in seconds.

request_timeout

Get request timeout in seconds.