BetaToolboxesOperations interface

Package:

@azure/ai-projects

Interface representing a BetaToolboxes operations.

Properties

createVersion	Create a new version of a toolbox. If the toolbox does not exist, it will be created.
delete	Delete a toolbox and all its versions.
deleteVersion	Delete a specific version of a toolbox.
get	Retrieve a toolbox.
getVersion	Retrieve a specific version of a toolbox.
list	List all toolboxes.
listVersions	List all versions of a toolbox.
update	Update a toolbox to point to a specific version.

Property Details

createVersion

Create a new version of a toolbox. If the toolbox does not exist, it will be created.

createVersion: (toolboxName: string, tools: ToolUnion[], options?: BetaToolboxesCreateVersionOptionalParams) => Promise<ToolboxVersionObject>

Property Value

(toolboxName: string, tools: ToolUnion[], options?: BetaToolboxesCreateVersionOptionalParams) => Promise<ToolboxVersionObject>

delete

Delete a toolbox and all its versions.

delete: (toolboxName: string, options?: BetaToolboxesDeleteOptionalParams) => Promise<void>

Property Value

(toolboxName: string, options?: BetaToolboxesDeleteOptionalParams) => Promise<void>

deleteVersion

Delete a specific version of a toolbox.

deleteVersion: (toolboxName: string, version: string, options?: BetaToolboxesDeleteVersionOptionalParams) => Promise<void>

Property Value

(toolboxName: string, version: string, options?: BetaToolboxesDeleteVersionOptionalParams) => Promise<void>

get

Retrieve a toolbox.

get: (toolboxName: string, options?: BetaToolboxesGetOptionalParams) => Promise<ToolboxObject>

Property Value

(toolboxName: string, options?: BetaToolboxesGetOptionalParams) => Promise<ToolboxObject>

getVersion

Retrieve a specific version of a toolbox.

getVersion: (toolboxName: string, version: string, options?: BetaToolboxesGetVersionOptionalParams) => Promise<ToolboxVersionObject>

Property Value

(toolboxName: string, version: string, options?: BetaToolboxesGetVersionOptionalParams) => Promise<ToolboxVersionObject>

list

List all toolboxes.

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

Property Value

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

listVersions

List all versions of a toolbox.

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

Property Value

(toolboxName: string, options?: BetaToolboxesListVersionsOptionalParams) => PagedAsyncIterableIterator<ToolboxVersionObject, ToolboxVersionObject[], PageSettings>

update

Update a toolbox to point to a specific version.

update: (toolboxName: string, defaultVersion: string, options?: BetaToolboxesUpdateOptionalParams) => Promise<ToolboxObject>

Property Value

(toolboxName: string, defaultVersion: string, options?: BetaToolboxesUpdateOptionalParams) => Promise<ToolboxObject>