ToolboxesOperations interface

Package:

@azure/ai-projects

Interface representing a Toolboxes operations.

Properties

createVersion	Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.
delete	Removes the specified toolbox along with all of its versions.
deleteVersion	Removes the specified version of a toolbox.
get	Retrieves the specified toolbox and its current configuration.
getVersion	Retrieves the specified version of a toolbox by name and version identifier.
list	Returns the toolboxes available in the current project.
listVersions	Returns the available versions for the specified toolbox.
update	Updates the toolbox's default version pointer to the specified version.

Property Details

createVersion

Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.

createVersion: (name: string, tools: ToolboxToolUnion[], options?: CreateVersionOptionalParams) => Promise<ToolboxVersionObject>

Property Value

(name: string, tools: ToolboxToolUnion[], options?: CreateVersionOptionalParams) => Promise<ToolboxVersionObject>

delete

Removes the specified toolbox along with all of its versions.

delete: (name: string, options?: ToolboxesDeleteOptionalParams) => Promise<void>

Property Value

(name: string, options?: ToolboxesDeleteOptionalParams) => Promise<void>

deleteVersion

Removes the specified version of a toolbox.

deleteVersion: (name: string, version: string, options?: DeleteVersionOptionalParams) => Promise<void>

Property Value

(name: string, version: string, options?: DeleteVersionOptionalParams) => Promise<void>

get

Retrieves the specified toolbox and its current configuration.

get: (name: string, options?: ToolboxesGetOptionalParams) => Promise<ToolboxObject>

Property Value

(name: string, options?: ToolboxesGetOptionalParams) => Promise<ToolboxObject>

getVersion

Retrieves the specified version of a toolbox by name and version identifier.

getVersion: (name: string, version: string, options?: GetVersionOptionalParams) => Promise<ToolboxVersionObject>

Property Value

(name: string, version: string, options?: GetVersionOptionalParams) => Promise<ToolboxVersionObject>

list

Returns the toolboxes available in the current project.

list: (options?: ToolboxesListOptionalParams) => PagedAsyncIterableIterator<ToolboxObject, ToolboxObject[], PageSettings>

Property Value

(options?: ToolboxesListOptionalParams) => PagedAsyncIterableIterator<ToolboxObject, ToolboxObject[], PageSettings>

listVersions

Returns the available versions for the specified toolbox.

listVersions: (name: string, options?: ListVersionsOptionalParams) => PagedAsyncIterableIterator<ToolboxVersionObject, ToolboxVersionObject[], PageSettings>

Property Value

(name: string, options?: ListVersionsOptionalParams) => PagedAsyncIterableIterator<ToolboxVersionObject, ToolboxVersionObject[], PageSettings>

update

Updates the toolbox's default version pointer to the specified version.

update: (name: string, defaultVersion: string, options?: ToolboxesUpdateOptionalParams) => Promise<ToolboxObject>

Property Value

(name: string, defaultVersion: string, options?: ToolboxesUpdateOptionalParams) => Promise<ToolboxObject>