ManagedOnlineDeployment Class

  • Reference

Managed Online endpoint deployment entity.

Managed Online endpoint deployment entity.

Constructor for Managed Online endpoint deployment entity.

Inheritance
azure.ai.ml.entities._deployment.online_deployment.OnlineDeployment
ManagedOnlineDeployment

Constructor

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)

Parameters

name
str

Name of the deployment resource

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
bool

Is appinsights enabled, defaults to False

scale_settings
Optional[Union[DefaultScaleSettings , TargetUtilizationScaleSettings]]

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_type
Optional[str]

Azure compute sku, defaults to None

instance_count
Optional[int]

The instance count used for this deployment, defaults to None

egress_public_network_access
Optional[str]

Whether to restrict communication between a deployment and the Azure resources used to by the deployment. Allowed values are: "enabled", "disabled", 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_path
Optional[Union[str, PathLike]]

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

data_collector
Optional[List[DataCollector]]

Data collector, defaults to None

name
str

Name of the deployment resource

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
bool

Is appinsights enabled, defaults to False

scale_settings
Optional[Union[DefaultScaleSettings , TargetUtilizationScaleSettings]]

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_type
Optional[str]

Azure compute sku, defaults to None

instance_count
Optional[int]

The instance count used for this deployment, defaults to None

egress_public_network_access
Optional[str]

Whether to restrict communication between a deployment and the Azure resources used to by the deployment. Allowed values are: "enabled", "disabled", 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

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) -> None

Parameters

dest
Union[PathLike, str, IO[AnyStr]]
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

Base path of the resource.

Returns

Base path of the resource

Return type

str

code_path

creation_context

Creation context.

Returns

Creation metadata of the resource.

Return type

Optional[SystemData]

id

Resource ID.

Returns

Global id of the resource, Azure Resource Manager ID

Return type

Optional[str]

provisioning_state

Deployment provisioning state, readonly.

Returns

Deployment provisioning state.

Return type

Optional[str]

scoring_script

type