forked from MicrosoftDocs/Virtualization-Documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update iron and cobalt release for HCS APIs
- Loading branch information
Fay Meng
committed
Dec 22, 2021
1 parent
657b255
commit 02864f7
Showing
12 changed files
with
1,386 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
95 changes: 95 additions & 0 deletions
95
virtualization/api/hcs/Reference/HcsCreateComputeSystemInNamespace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
title: HcsCreateComputeSystemInNamespace | ||
description: HcsCreateComputeSystemInNamespace | ||
author: faymeng | ||
ms.author: qiumeng | ||
ms.topic: reference | ||
ms.prod: virtualization | ||
ms.technology: virtualization | ||
ms.date: 06/09/2021 | ||
api_name: | ||
- HcsCreateComputeSystemInNamespace | ||
api_location: | ||
- computecore.dll | ||
api_type: | ||
- DllExport | ||
topic_type: | ||
- apiref | ||
--- | ||
# HcsCreateComputeSystemInNamespace | ||
|
||
## Description | ||
|
||
Creates a new compute system in a given namespace. | ||
|
||
## Syntax | ||
|
||
```cpp | ||
HRESULT WINAPI | ||
HcsCreateComputeSystemInNamespace( | ||
_In_ PCWSTR idNamespace, | ||
_In_ PCWSTR id, | ||
_In_ PCWSTR configuration, | ||
_In_ HCS_OPERATION operation, | ||
_In_opt_ const HCS_CREATE_OPTIONS* options, | ||
_Out_ HCS_SYSTEM* computeSystem | ||
); | ||
``` | ||
## Parameters | ||
`idNamespace` | ||
The string of the namespace to create the compute system. | ||
`id` | ||
Unique Id identifying the compute system. | ||
`configuration` | ||
JSON document specifying the settings of the [compute system](./../SchemaReference.md#ComputeSystem). The compute system document is expected to have a `Container`, `VirtualMachine` or `HostedSystem` property set since they are mutually exclusive. | ||
`operation` | ||
The handle to the operation that tracks the create operation. | ||
`securityDescriptor` | ||
Reserved for future use, must be `NULL`. | ||
`computeSystem` | ||
Receives a handle to the newly created compute system. It is the responsibility of the caller to release the handle using [HcsCloseComputeSystem](./HcsCloseComputeSystem.md) once it is no longer in use. | ||
## Return Values | ||
The function returns [HRESULT](./HCSHResult.md). | ||
If the return value is `S_OK`, it means the operation started successfully. Callers are expected to get the operation's result using [`HcsWaitForOperationResult`](./HcsWaitForOperationResult.md) or [`HcsGetOperationResult`](./HcsGetOperationResult.md). | ||
## Operation Results | ||
The return value of [`HcsWaitForOperationResult`](./HcsWaitForOperationResult.md) or [`HcsGetOperationResult`](./HcsGetOperationResult.md) based on current operation listed as below. | ||
| Operation Result Value | Description | | ||
| -- | -- | | ||
| `S_OK` | The compute system was created successfully | | ||
| `HCS_E_OPERATION_PENDING` | The compute system has not been fully created yet | | ||
| Other Windows `HRESULT` value | If something went wrong when creating the compute system, the return value here will give hints on what could have gone wrong | | ||
If the operation's result is not `S_OK`, then it's possible the result document might contain the error message. | ||
## Requirements | ||
|Parameter|Description| | ||
|---|---| | ||
| **Minimum supported client** | Windows 10, version 2004 | | ||
| **Minimum supported server** | Windows Server, version 2004 | | ||
| **Target Platform** | Windows | | ||
| **Header** | ComputeCore.h | | ||
| **Library** | ComputeCore.lib | | ||
| **Dll** | ComputeCore.dll | |
75 changes: 75 additions & 0 deletions
75
virtualization/api/hcs/Reference/HcsEnumerateComputeSystemsInNamespace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
title: HcsEnumerateComputeSystemsInNamespace | ||
description: HcsEnumerateComputeSystemsInNamespace | ||
author: faymeng | ||
ms.author: qiumeng | ||
ms.topic: reference | ||
ms.prod: virtualization | ||
ms.technology: virtualization | ||
ms.date: 06/09/2021 | ||
api_name: | ||
- HcsEnumerateComputeSystemsInNamespace | ||
api_location: | ||
- computecore.dll | ||
api_type: | ||
- DllExport | ||
topic_type: | ||
- apiref | ||
--- | ||
# HcsEnumerateComputeSystemsInNamespace | ||
|
||
## Description | ||
|
||
Enumerates existing compute systems in a given namespace. | ||
|
||
## Syntax | ||
|
||
```cpp | ||
HRESULT WINAPI | ||
HcsEnumerateComputeSystemsInNamespace( | ||
_In_ PCWSTR idNamespace, | ||
_In_opt_ PCWSTR query, | ||
_In_ HCS_OPERATION operation | ||
); | ||
``` | ||
## Parameters | ||
`idNamespace` | ||
The string contains the queried namespace. | ||
`query` | ||
Optional JSON document of [SystemQuery](./../SchemaReference.md#SystemQuery) specifying a query for specific compute systems. | ||
`operation` | ||
The handle to the operation that tracks the enumerate operation. | ||
## Return Values | ||
The function returns [HRESULT](./HCSHResult.md). | ||
If the return value is `S_OK`, it means the operation started successfully. Callers are expected to get the operation's result using [`HcsWaitForOperationResult`](./HcsWaitForOperationResult.md) or [`HcsGetOperationResult`](./HcsGetOperationResult.md) | ||
## Operation Results | ||
The return value of [`HcsWaitForOperationResult`](./HcsWaitForOperationResult.md) or [`HcsGetOperationResult`](./HcsGetOperationResult.md) based on current operation listed as below. | ||
| Operation Result Value | Description | | ||
| -- | -- | | ||
| `S_OK` | The operation was finished successfully, the result document returned by the hcs operation is a JSON document representing an array of compute system [Properties](./../SchemaReference.md#Properties) | | ||
## Requirements | ||
|Parameter|Description| | ||
|---|---| | ||
| **Minimum supported client** | Windows 10, version 2004 | | ||
| **Minimum supported server** | Windows Server, version 2004 | | ||
| **Target Platform** | Windows | | ||
| **Header** | ComputeCore.h | | ||
| **Library** | ComputeCore.lib | | ||
| **Dll** | ComputeCore.dll | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
virtualization/api/hcs/Reference/HcsGetProcessorCompatibilityFromSavedState.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
title: HcsGetProcessorCompatibilityFromSavedState | ||
description: HcsGetProcessorCompatibilityFromSavedState | ||
author: faymeng | ||
ms.author: qiumeng | ||
ms.topic: reference | ||
ms.prod: virtualization | ||
ms.technology: virtualization | ||
ms.date: 12/21/2021 | ||
api_name: | ||
- HcsGetProcessorCompatibilityFromSavedState | ||
api_location: | ||
- computecore.dll | ||
api_type: | ||
- DllExport | ||
topic_type: | ||
- apiref | ||
--- | ||
# HcsGetProcessorCompatibilityFromSavedState | ||
|
||
## Description | ||
|
||
Returns processor compatibility fields in JSON string format. | ||
|
||
## Syntax | ||
|
||
```cpp | ||
HRESULT WINAPI | ||
HcsGetProcessorCompatibilityFromSavedState( | ||
PCWSTR RuntimeFileName, | ||
_Outptr_opt_ PCWSTR* ProcessorFeaturesString | ||
); | ||
``` | ||
## Parameters | ||
`RuntimeFileName` | ||
The path to the vmrs file. | ||
`ProcessorFeaturesString` | ||
JSON document of the processor compatibilities as [VmProcessorRequirements](./../SchemaReference.md#VmProcessorRequirements). | ||
The caller is responsible for releasing the returned string using [`LocalFree`](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-localfree). | ||
## Return Values | ||
The function returns [HRESULT](./HCSHResult.md). | ||
## Requirements | ||
|Parameter|Description| | ||
|---|---| | ||
| **Minimum supported client** | Windows 10, version 2104| | ||
| **Minimum supported server** | Windows Server 2022 | | ||
| **Target Platform** | Windows | | ||
| **Header** | ComputeCore.h | | ||
| **Library** | ComputeCore.lib | | ||
| **Dll** | ComputeCore.dll | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
virtualization/api/hcs/Reference/HcsOpenComputeSystemInNamespace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
title: HcsOpenComputeSystemInNamespace | ||
description: HcsOpenComputeSystemInNamespace | ||
author: faymeng | ||
ms.author: qiumeng | ||
ms.topic: reference | ||
ms.prod: virtualization | ||
ms.technology: virtualization | ||
ms.date: 06/09/2021 | ||
api_name: | ||
- HcsOpenComputeSystemInNamespace | ||
api_location: | ||
- computecore.dll | ||
api_type: | ||
- DllExport | ||
topic_type: | ||
- apiref | ||
--- | ||
# HcsOpenComputeSystemInNamespace | ||
|
||
## Description | ||
|
||
Opens a handle to an existing compute system in a given namespace. | ||
|
||
## Syntax | ||
|
||
```cpp | ||
HRESULT WINAPI | ||
HcsOpenComputeSystemInNamespace( | ||
_In_ PCWSTR idNamespace, | ||
_In_ PCWSTR id, | ||
_In_ DWORD requestedAccess, | ||
_Out_ HCS_SYSTEM* computeSystem | ||
); | ||
``` | ||
## Parameters | ||
`idNamespace` | ||
The string contains the namespace of the compute system to open. | ||
`id` | ||
Unique Id identifying the compute system. | ||
`requestedAccess` | ||
Reserved for future use, must be `GENERIC_ALL`. | ||
`computeSystem` | ||
Receives a handle to the compute system. It is the responsibility of the caller to release the handle using [HcsCloseComputeSystem](./HcsCloseComputeSystem.md) once it is no longer in use. | ||
## Return Values | ||
The function returns [HRESULT](./HCSHResult.md). | ||
## Requirements | ||
|Parameter|Description| | ||
|---|---| | ||
| **Minimum supported client** | Windows 10, version 2004 | | ||
| **Minimum supported server** | Windows Server, version 2004 | | ||
| **Target Platform** | Windows | | ||
| **Header** | ComputeCore.h | | ||
| **Library** | ComputeCore.lib | | ||
| **Dll** | ComputeCore.dll | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.