Class CreateSandboxDetails

Request body used to create a sandbox.

Inheritance

object

CreateSandboxDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaisandboxService.Models

Assembly: OCI.DotNetSDK.Generativeaisandbox.dll

Syntax

public class CreateSandboxDetails

Properties

CredentialProfileLabel

Declaration

[JsonProperty(PropertyName = "credentialProfileLabel")]
public string CredentialProfileLabel { get; set; }

Property Value

Type	Description
string	The Project credential profile selected for this Sandbox. Omit this field to select no credential profile. The selection and its configuration snapshot are immutable for the lifetime of the Sandbox; later Project profile updates apply only to subsequently created Sandboxes after configuration propagation.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	User-provided display name for the sandbox.

EnvironmentVariables

Declaration

[JsonProperty(PropertyName = "environmentVariables")]
public List<EnvironmentVariable> EnvironmentVariables { get; set; }

Property Value

Type	Description
List<EnvironmentVariable>	Environment variables to inject into the sandbox runtime.

ExpirationDuration

Declaration

[JsonProperty(PropertyName = "expirationDuration")]
public string ExpirationDuration { get; set; }

Property Value

Type	Description
string	Deprecated. Use `expiresInMinutes` instead. Existing clients may pass `-1` to disable automatic expiration.

ExpiresInMinutes

Declaration

[JsonProperty(PropertyName = "expiresInMinutes")]
public int? ExpiresInMinutes { get; set; }

Property Value

Type	Description
int?	Number of minutes from creation until automatic sandbox expiration. Use `-1` to disable automatic expiration.

PublishPorts

Declaration

[JsonProperty(PropertyName = "publishPorts")]
public List<string> PublishPorts { get; set; }

Property Value

Type	Description
List<string>	Published ports to expose for the sandbox.

PublishedPortAuthMode

Declaration

[JsonProperty(PropertyName = "publishedPortAuthMode")]
[JsonConverter(typeof(StringEnumConverter))]
public Sandbox.PublishedPortAuthModeEnum? PublishedPortAuthMode { get; set; }

Property Value

Type	Description
Sandbox.PublishedPortAuthModeEnum?	Authorization for all published-port HTTP requests and WebSocket handshakes. OCI_IAM requires Sandbox use and project read permission on the owning project. Omission defaults to OCI_IAM for new sandboxes with published ports in enabled tenancies; elsewhere omission retains legacy behavior. Explicit OCI_IAM outside the rollout, null, unsupported values, or a mode without published ports are rejected. The effective mode is immutable and is preserved when restoring protected snapshots.

Type

Description

Sandbox.PublishedPortAuthModeEnum?

Authorization for all published-port HTTP requests and WebSocket handshakes. OCI_IAM requires Sandbox use and project read permission on the owning project. Omission defaults to OCI_IAM for new sandboxes with published ports in enabled tenancies; elsewhere omission retains legacy behavior. Explicit OCI_IAM outside the rollout, null, unsupported values, or a mode without published ports are rejected. The effective mode is immutable and is preserved when restoring protected snapshots.

Runtime

Declaration

[JsonProperty(PropertyName = "runtime")]
public string Runtime { get; set; }

Property Value

Type	Description
string	Runtime identifier for the sandbox, either a built-in runtime such as python-3.11 or a same-region Oracle Cloud Infrastructure Registry customer image reference.

Shape

Declaration

[JsonProperty(PropertyName = "shape")]
[JsonConverter(typeof(StringEnumConverter))]
public Sandbox.ShapeEnum? Shape { get; set; }

Property Value

Type	Description
Sandbox.ShapeEnum?	Compute shape for the sandbox.

Source

Declaration

[JsonProperty(PropertyName = "source")]
public SandboxSource Source { get; set; }

Property Value

Type	Description
SandboxSource

WarmpoolName

Declaration

[JsonProperty(PropertyName = "warmpoolName")]
public string WarmpoolName { get; set; }

Property Value

Type	Description
string	Name of a MANAGED or CUSTOM warm pool in the owning project. Runtime and shape are derived from the pool; explicit values must match. Deleting pools cannot be used. Snapshot restore, credential brokerage, and nested resource principals are not supported with named pools. An empty pool may cold-create using its same template, including when desired capacity is zero. Zero capacity stops idle prewarming; it does not prevent creation from an available applied template. When warmpoolName is omitted, a built-in runtime can automatically select an eligible named MANAGED pool in the same project matching its runtime and shape. Omitted runtime defaults to python-3.11 and omitted shape defaults to SMALL for automatic matching. A digest-pinned customer image can automatically select an eligible CUSTOM pool in the same project matching its canonical registry host, repository, digest and shape. Tag-based customer images are not automatically matched. Matching pools are considered in name order; the first with a valid applied template is selected without reading ready counts. Empty pools and zero desired or applied capacity still allow cold creation through the selected template. If no eligible pool is found or automatic lookup is unavailable, built-in runtimes use the existing managed runtime path, and customer images use the ordinary direct customer-image path with its existing validation. Automatic matching does not apply when source is supplied, including snapshot restore, or when credential brokerage or nested resource principals are used. Explicit names retain strict validation and do not fall back to automatic matching or another creation path. Retries preserve the original persisted pool binding or the original managed or direct customer-image route, even when matching pools change. Sandbox and SandboxSummary report an automatically selected pool in warmpoolName.

Type

Description

string

Name of a MANAGED or CUSTOM warm pool in the owning project. Runtime and shape are derived from the pool; explicit values must match. Deleting pools cannot be used. Snapshot restore, credential brokerage, and nested resource principals are not supported with named pools. An empty pool may cold-create using its same template, including when desired capacity is zero. Zero capacity stops idle prewarming; it does not prevent creation from an available applied template. When warmpoolName is omitted, a built-in runtime can automatically select an eligible named MANAGED pool in the same project matching its runtime and shape. Omitted runtime defaults to python-3.11 and omitted shape defaults to SMALL for automatic matching. A digest-pinned customer image can automatically select an eligible CUSTOM pool in the same project matching its canonical registry host, repository, digest and shape. Tag-based customer images are not automatically matched. Matching pools are considered in name order; the first with a valid applied template is selected without reading ready counts. Empty pools and zero desired or applied capacity still allow cold creation through the selected template. If no eligible pool is found or automatic lookup is unavailable, built-in runtimes use the existing managed runtime path, and customer images use the ordinary direct customer-image path with its existing validation. Automatic matching does not apply when source is supplied, including snapshot restore, or when credential brokerage or nested resource principals are used. Explicit names retain strict validation and do not fall back to automatic matching or another creation path. Retries preserve the original persisted pool binding or the original managed or direct customer-image route, even when matching pools change. Sandbox and SandboxSummary report an automatically selected pool in warmpoolName.