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, *, display_name: str | None = None, 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_types: List[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, accelerator_maps: List[AcceleratorMap] | None = None, **kwargs)

Parameters

Name Description
name
Required
str

Name of the deployment template.
version
Required
str

Version of the deployment template.

Keyword-Only Parameters

Name Description
description
str

Description of the deployment template.

Default value: None
environment
Environment

Environment for the deployment template.

Default value: None
request_settings
OnlineRequestSettings

Request settings for the deployment template.

Default value: None
liveness_probe
ProbeSettings

Liveness probe settings.

Default value: None
readiness_probe
ProbeSettings

Readiness probe settings.

Default value: None
instance_count
int

Number of instances for the deployment template.

Default value: None
instance_type
str

Instance type for the deployment template.

Default value: None
model
str

Model for the deployment template.

Default value: None
code_configuration
dict

Code configuration for the deployment template.

Default value: None
environment_variables
dict

Environment variables for the deployment template.

Default value: None
app_insights_enabled
bool

Whether application insights is enabled.

Default value: None
display_name
str

Display name of the deployment template.

Default value: None
stage
str

Stage of the deployment template. Can be "Active" or "Archived".

Default value: None
accelerator_maps
list[AcceleratorMap]

List of accelerator maps describing the accelerator types and their configurations for this deployment template.

Default value: None
allowed_instance_types
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

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.