DeploymentTemplateOperations Class

DeploymentTemplateOperations.

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.

Constructor

DeploymentTemplateOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_04_2024_dataplanepreview, **kwargs: Dict[str, Any])

Parameters

Name Description
operation_scope
Required
operation_config
Required
service_client_04_2024_dataplanepreview
Required

Methods

archive

Note

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

Archive a deployment template by setting its stage to 'Archived'.
create_or_update

Note

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

Create or update a deployment template.
delete

Note

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

Delete a deployment template.
get

Note

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

Get a deployment template by name and version.
list

Note

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

List deployment templates.
restore

Note

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

Restore a deployment template by setting its stage to 'Development'.

archive

Note

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

Archive a deployment template by setting its stage to 'Archived'.

archive(name: str, version: str | None = None, **kwargs: Any) -> DeploymentTemplate

Parameters

Name Description
name
Required
str

Name of the deployment template to archive.
version
Optional[str]

Version of the deployment template to archive. If not provided, archives the latest version.

Default value: None

Returns

Type Description
DeploymentTemplate

DeploymentTemplate object representing the archived template.

Exceptions

Type Description
azure.core.exceptions.ResourceNotFoundError if deployment template not found.

create_or_update

Note

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

Create or update a deployment template.

create_or_update(deployment_template: DeploymentTemplate, **kwargs: Any) -> DeploymentTemplate

Parameters

Name Description
deployment_template
Required
Union[DeploymentTemplate, Dict[str, Any], str, <xref:PathLike>]

DeploymentTemplate object to create or update, dictionary containing deployment template definition, or path to a YAML file containing deployment template definition.

Returns

Type Description
DeploymentTemplate

DeploymentTemplate object representing the created or updated resource.

delete

Note

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

Delete a deployment template.

delete(name: str, version: str | None = None, **kwargs: Any) -> None

Parameters

Name Description
name
Required
str

Name of the deployment template to delete.
version
Optional[str]

Version of the deployment template to delete. If not provided, deletes the latest version.

Default value: None

get

Note

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

Get a deployment template by name and version.

get(name: str, version: str | None = None, **kwargs: Any) -> DeploymentTemplate

Parameters

Name Description
name
Required
str

Name of the deployment template.
version
Optional[str]

Version of the deployment template. If not provided, gets the latest version.

Default value: None

Returns

Type Description
DeploymentTemplate

DeploymentTemplate object.

Exceptions

Type Description
azure.core.exceptions.ResourceNotFoundError if deployment template not found.

list

Note

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

List deployment templates.

list(*, name: str | None = None, tags: str | None = None, count: int | None = None, stage: str | None = None, list_view_type: str = 'ActiveOnly', **kwargs: Any) -> Iterable[DeploymentTemplate]

Keyword-Only Parameters

Name Description
name
Optional[str]

Filter by deployment template name.

Default value: None
tags
Optional[str]

Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2.

Default value: None
count
Optional[int]

Maximum number of items to return.

Default value: None
stage
Optional[str]

Filter by deployment template stage.

Default value: None
list_view_type
str

View type for including/excluding (for example) archived entities.

Default value: ActiveOnly

Returns

Type Description
ItemPaged[DeploymentTemplate]

Iterator of deployment template objects.

restore

Note

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

Restore a deployment template by setting its stage to 'Development'.

restore(name: str, version: str | None = None, **kwargs: Any) -> DeploymentTemplate

Parameters

Name Description
name
Required
str

Name of the deployment template to restore.
version
Optional[str]

Version of the deployment template to restore. If not provided, restores the latest version.

Default value: None

Returns

Type Description
DeploymentTemplate

DeploymentTemplate object representing the restored template.

Exceptions

Type Description
azure.core.exceptions.ResourceNotFoundError if deployment template not found.