OnlineDeploymentOperations Class

  • Reference

OnlineDeploymentOperations.

You should not instantiate this class directly. Instead, you should create an MLClient instance that instantiates it for you and attaches it as an attribute.

Inheritance
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
OnlineDeploymentOperations

Constructor

OnlineDeploymentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_04_2023_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, local_deployment_helper: _LocalDeploymentHelper, credentials: TokenCredential | None = None, **kwargs: Dict)

Parameters

Name Description
operation_scope
Required
operation_config
Required
service_client_04_2023_preview
Required
all_operations
Required
local_deployment_helper
Required
credentials
default value: None

Methods

begin_create_or_update

Create or update a deployment.
begin_delete

Delete a deployment.
get

Get a deployment resource.
get_logs

Retrive the logs from online deployment.
list

List a deployment resource.

begin_create_or_update

Create or update a deployment.

begin_create_or_update(deployment: OnlineDeployment, *, local: bool = False, vscode_debug: bool = False, skip_script_validation: bool = False, local_enable_gpu: bool = False, **kwargs: Any) -> LROPoller[OnlineDeployment]

Parameters

Name Description
deployment
Required
OnlineDeployment

the deployment entity

Keyword-Only Parameters

Name Description
local
bool

Whether deployment should be created locally, defaults to False
vscode_debug
bool

Whether to open VSCode instance to debug local deployment, defaults to False
local_enable_gpu
bool

enable local container to access gpu

Returns

Type Description
LROPoller[OnlineDeployment]

A poller to track the operation status

Exceptions

Type Description
ValidationException

Raised if OnlineDeployment cannot be successfully validated. Details will be provided in the error message.
AssetException

Raised if OnlineDeployment assets (e.g. Data, Code, Model, Environment) cannot be successfully validated. Details will be provided in the error message.
ModelException

Raised if OnlineDeployment model cannot be successfully validated. Details will be provided in the error message.
DeploymentException

Raised if OnlineDeployment type is unsupported. Details will be provided in the error message.
LocalEndpointNotFoundError

Raised if local endpoint resource does not exist.
LocalEndpointInFailedStateError

Raised if local endpoint is in a failed state.
InvalidLocalEndpointError

Raised if Docker image cannot be found for local deployment.
LocalEndpointImageBuildError

Raised if Docker image cannot be successfully built for local deployment.
RequiredLocalArtifactsNotFoundError

Raised if local artifacts cannot be found for local deployment.
InvalidVSCodeRequestError

Raised if VS Debug is invoked with a remote endpoint. VSCode debug is only supported for local endpoints.
LocalDeploymentGPUNotAvailable

Raised if Nvidia GPU is not available in the system and local_enable_gpu is set while local deployment
VSCodeCommandNotFound

Raised if VSCode instance cannot be instantiated.

begin_delete

Delete a deployment.

begin_delete(name: str, endpoint_name: str, *, local: bool | None = False) -> LROPoller[None]

Parameters

Name Description
name
Required
str

The name of the deployment
endpoint_name
Required
str

The name of the endpoint

Keyword-Only Parameters

Name Description
local
Optional[bool]

Whether deployment should be retrieved from local docker environment, defaults to False

Returns

Type Description
LROPoller[None]

A poller to track the operation status

Exceptions

Type Description
LocalEndpointNotFoundError

Raised if local endpoint resource does not exist.

get

Get a deployment resource.

get(name: str, endpoint_name: str, *, local: bool | None = False) -> OnlineDeployment

Parameters

Name Description
name
Required
str

The name of the deployment
endpoint_name
Required
str

The name of the endpoint

Keyword-Only Parameters

Name Description
local
Optional[bool]

Whether deployment should be retrieved from local docker environment, defaults to False

Returns

Type Description
OnlineDeployment

a deployment entity

Exceptions

Type Description
LocalEndpointNotFoundError

Raised if local endpoint resource does not exist.

get_logs

Retrive the logs from online deployment.

get_logs(name: str, endpoint_name: str, lines: int, *, container_type: str | None = None, local: bool = False) -> str

Parameters

Name Description
name
Required
str

The name of the deployment
endpoint_name
Required
str

The name of the endpoint
lines
Required
int

The maximum number of lines to tail

Keyword-Only Parameters

Name Description
container_type

The type of container to retrieve logs from. Possible values include: "StorageInitializer", "InferenceServer", defaults to None
local
bool

[description], defaults to False

Returns

Type Description
str

the logs

Exceptions

Type Description
ValidationException

Raised if OnlineDeployment cannot be successfully validated. Details will be provided in the error message.
AssetException

Raised if OnlineDeployment assets (e.g. Data, Code, Model, Environment) cannot be successfully validated. Details will be provided in the error message.
ModelException

Raised if OnlineDeployment model cannot be successfully validated. Details will be provided in the error message.
DeploymentException

Raised if OnlineDeployment type is unsupported. Details will be provided in the error message.
LocalEndpointNotFoundError

Raised if local endpoint resource does not exist.
LocalEndpointInFailedStateError

Raised if local endpoint is in a failed state.
InvalidLocalEndpointError

Raised if Docker image cannot be found for local deployment.
LocalEndpointImageBuildError

Raised if Docker image cannot be successfully built for local deployment.
RequiredLocalArtifactsNotFoundError

Raised if local artifacts cannot be found for local deployment.
InvalidVSCodeRequestError

Raised if VS Debug is invoked with a remote endpoint. VSCode debug is only supported for local endpoints.
LocalDeploymentGPUNotAvailable

Raised if Nvidia GPU is not available in the system and local_enable_gpu is set while local deployment
VSCodeCommandNotFound

Raised if VSCode instance cannot be instantiated.

list

List a deployment resource.

list(endpoint_name: str, *, local: bool = False) -> ItemPaged[OnlineDeployment]

Parameters

Name Description
endpoint_name
Required
str

The name of the endpoint

Keyword-Only Parameters

Name Description
local
bool

Whether deployment should be retrieved from local docker environment, defaults to False

Returns

Type Description
Iterable[OnlineDeployment]

an iterator of deployment entities

Exceptions

Type Description
ValidationException

Raised if OnlineDeployment cannot be successfully validated. Details will be provided in the error message.
AssetException

Raised if OnlineDeployment assets (e.g. Data, Code, Model, Environment) cannot be successfully validated. Details will be provided in the error message.
ModelException

Raised if OnlineDeployment model cannot be successfully validated. Details will be provided in the error message.
DeploymentException

Raised if OnlineDeployment type is unsupported. Details will be provided in the error message.
LocalEndpointNotFoundError

Raised if local endpoint resource does not exist.
LocalEndpointInFailedStateError

Raised if local endpoint is in a failed state.
InvalidLocalEndpointError

Raised if Docker image cannot be found for local deployment.
LocalEndpointImageBuildError

Raised if Docker image cannot be successfully built for local deployment.
RequiredLocalArtifactsNotFoundError

Raised if local artifacts cannot be found for local deployment.
InvalidVSCodeRequestError

Raised if VS Debug is invoked with a remote endpoint. VSCode debug is only supported for local endpoints.
LocalDeploymentGPUNotAvailable

Raised if Nvidia GPU is not available in the system and local_enable_gpu is set while local deployment
VSCodeCommandNotFound

Raised if VSCode instance cannot be instantiated.