Interface ISandboxTemplateClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Reusable sandbox workload templates, scoped to one workspace.

public interface ISandboxTemplateClient

Methods

CreateAsync(SandboxWorkloadTemplate, string?, CancellationToken)

Creates a template. Name is required.

ValueTask<SandboxWorkloadTemplate> CreateAsync(SandboxWorkloadTemplate workloadTemplate, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

workloadTemplate SandboxWorkloadTemplate

requestId string

cancellationToken CancellationToken

Returns

ValueTask<SandboxWorkloadTemplate>

DeleteAsync(string, DeleteOptions?, CancellationToken)

Deletes a template. Inspect Outcome.

ValueTask<DeletionResult> DeleteAsync(string name, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

name string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

GetAsync(string, CancellationToken)

Gets a template by name.

ValueTask<SandboxWorkloadTemplate> GetAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

cancellationToken CancellationToken

Returns

ValueTask<SandboxWorkloadTemplate>

List(ListOptions?)

Lists templates lazily; set AllWorkspaces to span workspaces.

Pager<SandboxWorkloadTemplate> List(ListOptions? options = null)

Parameters

options ListOptions

Returns

Pager<SandboxWorkloadTemplate>