.alter cluster policy sandbox command

Applies to: ✅ Azure Data Explorer

Changes the cluster sandbox policy. Specified plugins run within sandboxes whose resources are managed for security and resource governance. Sandbox limitations are defined in sandbox policies, where each sandbox kind can have its own policy. Your cluster can run sandboxes for specific flows that need secure isolation. Examples of these flows are user-defined scripts that run using the Python plugin or the R plugin.

Sandbox policies are managed at cluster-level and affect all the nodes in the cluster.

Permissions

You must have AllDatabasesAdmin permissions to run this command.

Syntax

.alter cluster policy sandbox ArrayOfPolicyObjects

Learn more about syntax conventions.

Parameters

Name Type Required Description
ArrayOfPolicyObjects string ✔️ An array with one or more policy objects defined. For policy object definitions, the sandbox policy.

Returns

Returns a JSON representation of the policy.

Example

Modifies the collection of sandbox policies at the cluster level.

.alter cluster policy sandbox ```[
  {
    "SandboxKind": "PythonExecution",
    "IsEnabled": true,
    "InitializeOnStartup": false,
    "TargetCountPerNode": 3,
    "MaxCpuRatePerSandbox": 50,
    "MaxMemoryMbPerSandbox": 10240
  },
  {
    "SandboxKind": "RExecution",
    "IsEnabled": true,
    "InitializeOnStartup": false,
    "TargetCountPerNode": 4,
    "MaxCpuRatePerSandbox": 50,
    "MaxMemoryMbPerSandbox": 8192
  }
]```