HcsModifyComputeSystem

Description

Modifies settings of a compute system, see sample code for simple example.

Syntax

HRESULT WINAPI
HcsModifyComputeSystem(
    _In_ HCS_SYSTEM computeSystem,
    _In_ HCS_OPERATION operation,
    _In_ PCWSTR configuration,
    _In_opt_ HANDLE identity
    );

Parameters

computeSystem

Handle the compute system to modify.

operation

Handle to the operation that tracks the modify operation.

configuration

JSON document of ModifySettingRequest specifying the settings to modify.

identity

Optional handle to an access token that is used when applying the settings.

Return Values

The function returns HRESULT.

If the return value is S_OK, it means the operation started successfully. Callers are expected to get the operation's result using HcsWaitForOperationResult or HcsGetOperationResult.

Operation Results

The return value of HcsWaitForOperationResult or HcsGetOperationResult based on current operation listed as below.

Remarks

The ModifySettingRequest JSON document has a property called "Settings" of type Any. In JSON, Any means an arbitrary object with no restrictions. Refer to the following table to know what JSON type HCS expects for each "ResourcePath".

Requirements