KubernetesOnlineDeployment Class

Kubernetes Online endpoint deployment entity.

Kubernetes Online endpoint deployment entity.

Constructor for Kubernetes Online endpoint deployment entity.

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

Constructor

KubernetesOnlineDeployment(*, 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, resources: ResourceRequirementsSettings | None = None, instance_count: int | None = None, instance_type: str | None = None, code_path: PathLike | str | None = None, scoring_script: PathLike | str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

Name of the deployment resource.

endpoint_name

Name of the endpoint resource, defaults to None

tags

Tag dictionary. Tags can be added, removed, and updated., defaults to None

properties

The asset property dictionary, defaults to None

description

Description of the resource, defaults to None

model

Model entity for the endpoint deployment, defaults to None

code_configuration

Code Configuration, defaults to None

environment

Environment entity for the endpoint deployment, defaults to None

app_insights_enabled

Is appinsights enabled, defaults to False

scale_settings

How the online deployment will scale, defaults to None

request_settings

Online Request Settings, defaults to None

liveness_probe

Liveness probe settings, defaults to None

readiness_probe

Readiness probe settings, defaults to None

environment_variables

Environment variables that will be set in deployment, defaults to None

resources

Resource requirements settings, defaults to None

instance_count

The instance count used for this deployment, defaults to None

instance_type

The instance type defined by K8S cluster admin, defaults to None

code_path

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

scoring_script

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

name
str

Name of the deployment resource.

endpoint_name

Name of the endpoint resource, defaults to None

tags

Tag dictionary. Tags can be added, removed, and updated., defaults to None

properties

The asset property dictionary, defaults to None

description

Description of the resource, defaults to None

model

Model entity for the endpoint deployment, defaults to None

code_configuration

Code Configuration, defaults to None

environment

Environment entity for the endpoint deployment, defaults to None

app_insights_enabled

Is appinsights enabled, defaults to False

scale_settings

How the online deployment will scale, defaults to None

request_settings

Online Request Settings, defaults to None

liveness_probe

Liveness probe settings, defaults to None

readiness_probe

Readiness probe settings, defaults to None

environment_variables

Environment variables that will be set in deployment, defaults to None

resources

Resource requirements settings, defaults to None

instance_count

The instance count used for this deployment, defaults to None

instance_type

The instance type defined by K8S cluster admin, defaults to None

code_path

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

scoring_script

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

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

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description

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

provisioning_state

Deployment provisioning state, readonly.

Returns

Type Description

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