AI Service Project

https://learn.microsoft.com/en-us/openspecs/windows_protocols/
Admin
A project related to AI services and models, likely implemented with TypeScript.
Tokens:6,166,409
Snippets:66,353
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start (Opnum 8)

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-iiss/1a473368-18b0-45dc-8866-066758079d83

This method is used to start all Internet services that are marked to start automatically when the computer starts up. The server can have all functionality through this interface disabled. If disabled, the function MUST return an error (E_ERROR_RESOURCE_DISABLED) and MUST NOT perform any other action.

```APIDOC
## Start (Opnum 8)

### Description
This method is used to start Internet services. If the interface functionality is disabled, the server MUST return an error and MUST NOT perform any other action. Otherwise, the server SHOULD start all Internet services marked to start automatically.

### Method
Not specified (RPC method)

### Endpoint
Not applicable (RPC method)

### Parameters
#### Input Parameters
*   **dwTimeoutMsecs** (DWORD) - The length of time, in milliseconds, allowed to start the services. After this time has passed, the server MUST return E_ERROR_SERVICE_REQUEST_TIMEOUT.

### Return Values
A signed 32-bit value indicating return status. Negative values indicate failure. Positive values indicate success.

*   **0x00000000 S_OK**: The call was successful.
*   **0x80070008 E_ERROR_NOT_ENOUGH_MEMORY**: Not enough memory is available to process this command.
*   **0x8007041D E_ERROR_SERVICE_REQUEST_TIMEOUT**: A time-out has occurred while waiting for all Internet services to be started.
*   **0x800710D5 E_ERROR_RESOURCE_DISABLED**: The IIisServiceControl Interface is disabled.

### Request Example
```
HRESULT Start(
  DWORD dwTimeoutMsecs
);
```

### Response
#### Success Response (S_OK)
Indicates the services were started successfully.

#### Response Example
```
0x00000000
```
```

--------------------------------

### Server Get Device Capability Request Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpexps/5d69422d-0a50-40d4-bb4e-f4aa78151aab

This example illustrates the byte structure for a server's Get Device Capability Request, detailing InterfaceId, MessageId, and request-specific fields.

```text
00000000 00 00 00 00 00 00 00 00 04 01 00 00 00 00 00 00
00000010 0b 00 00 00 00 00

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
04 01 00 00 -> GET_DEVICE_CAP_REQ = 0x104
00 00 00 00 -> cbDevmodeIn = 0
           -> DevmodeIn (variable size=0)
0b 00      -> DeviceCap
00 00 00 00 -> InputBufferSize = 0
```

--------------------------------

### SyncUpdates Request Example (Second from WinXP)

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wusp/f9f47314-d480-4087-a86b-d9d2a86de3aa

This example shows the second SyncUpdates request from a Windows XP client, including a list of installed non-leaf update IDs and other cached update IDs.

```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="ht
  tp://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSche
  ma" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
 <soap:Body>
 <SyncUpdates xmlns="http://www.microsoft.com/SoftwareDistribution/Server/ClientWe
  bService">
 <cookie>
 <Expiration>2006-05-23T04:06:32.9843746Z</Expiration>
 <EncryptedData>aOEIdlPlPHBDVMJgwkbRuDeInZcJr/v272AcY/kDqTghmncGveoB80UQI9jzAQY6
  N9Hio13440BbUAtx640sUkvw8lFh+0rupjSFg/KWq4CSpUoESWlfKItW+RnYS5bc7T/5ORSr+7BOf
  8Xy6SP3EkuRqDm2Y/AXphfLoJhSXW1AifcyLuzQf5VOBoyYjIL7elkKt1JKMHCfyAeiHEy3Si6a0r
  gu/2endOWn5CLxgmlDlfsmmewhk/omaKr2Lk8rnBMf5Qiid76jvMwnbO7PeA==
 </EncryptedData>
 </cookie>
 <parameters>
 <ExpressQuery>false</ExpressQuery>
 <InstalledNonLeafUpdateIDs soapenc:arrayType="xsd:int[1]">
 <int>109</int>
 </InstalledNonLeafUpdateIDs>
 <OtherCachedUpdateIDs soapenc:arrayType="xsd:int[29]">
 <int>101</int>
 <int>102</int>
 <int>103</int>
 <int>104</int>
 <int>105</int>
 <int>106</int>
 <int>107</int>
 <int>108</int>
 <int>110</int>
 <int>111</int>
 <int>112</int>
 <int>113</int>
 <int>114</int>
 <int>115</int>
 <int>378</int>
 <int>379</int>
 <int>380</int>
 <int>381</int>
 <int>382</int>
 <int>383</int>
 <int>384</int>
 <int>385</int>
 <int>386</int>
 <int>387</int>
 <int>388</int>
 <int>389</int>
 <int>390</int>
 <int>391</int>
 <int>392</int>
 </OtherCachedUpdateIDs>
 <SystemSpec xsi:nil="1" />
 <CachedDriverIDs xsi:nil="1" />
 <SkipSoftwareSync>false</SkipSoftwareSync>
 </parameters>
 </SyncUpdates>
 </soap:Body>
</soap:Envelope>
```

--------------------------------

### StartWSUSService

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Starts the WSUS service on the server.

```APIDOC
## StartWSUSService

### Description
This operation starts the Windows Server Update Services (WSUS) service. This is used to enable WSUS functionality after it has been stopped or during server startup.

### Method
POST

### Endpoint
/wsus/service/start

### Request Body
This operation does not require a request body.

### Response
#### Success Response (200)
Indicates that the WSUS service has been successfully started.

#### Response Example
```json
{
  "status": "success",
  "message": "WSUS service started successfully."
}
```
```

--------------------------------

### SyncUpdates Request Example (Third from WinXP)

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wusp/f9f47314-d480-4087-a86b-d9d2a86de3aa

This example shows the third SyncUpdates request from a Windows XP client, including an updated list of installed non-leaf update IDs and a larger set of other cached update IDs.

```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="h
  ttp://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSc
  hema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
 <soap:Body>
 <SyncUpdates xmlns="http://www.microsoft.com/SoftwareDistribution/Server/ClientW
  ebService">
 <cookie>
 <Expiration>2006-05-23T04:06:32.9843746Z</Expiration>
 <EncryptedData>ae5VXUP5lEJygdVCP7NnJFmZVzmsbo8agdMfdqYe03xJfNw/P2SpXL/RtaBlQzc
  TTLn8SUarYVnekc1XU/c5MP+7MNdW1b9xERCy+Vm/CXNFluJ64veTPuVGgJ8wtlIAcsEHVmCNbhw
  UXnb1wS/YOnUC3OmcXdwQcVRWAASxepjBaF/Y8em5KGn37XW75D0cSCVdmUts+uGMgQ2QYze5AuC
  WDAqpHf0x2jSb8QfL2Ygljs44gLGOIlN40E72tLpQuIe3yn9C4lAg0VKdbAsieA==
 </EncryptedData>
 </cookie>
 <parameters>
 <ExpressQuery>false</ExpressQuery>
 <InstalledNonLeafUpdateIDs soapenc:arrayType="xsd:int[2]">
 <int>109</int>
 <int>191</int>
 </InstalledNonLeafUpdateIDs>
 <OtherCachedUpdateIDs soapenc:arrayType="xsd:int[58]">
 <int>39</int>
 <int>40</int>
 <int>41</int>
 <int>42</int>
 <int>43</int>
 <int>44</int>
 <int>45</int>
 <int>46</int>
 <int>47</int>
 <int>48</int>
 <int>49</int>
 <int>50</int>
 <int>51</int>
 <int>52</int>
 <int>53</int>
 <int>54</int>
 <int>55</int>
 <int>56</int>
 <int>57</int>
 <int>58</int>
 <int>97</int>
 <int>99</int>
 <int>100</int>
 <int>101</int>
 <int>102</int>
 <int>103</int>
 <int>104</int>
 <int>105</int>
 <int>106</int>
 <int>107</int>
 </OtherCachedUpdateIDs>
 </parameters>
 </SyncUpdates>
 </soap:Body>
</soap:Envelope>
```

--------------------------------

### CreateInstallApprovalRule

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Creates a new install approval rule.

```APIDOC
## CreateInstallApprovalRule

### Description
Creates a new install approval rule.

### Method
POST (assumed, based on naming convention)

### Endpoint
/CreateInstallApprovalRule

### Parameters
#### Request Body
- **name** (string) - Optional - The name for the new approval rule.

### Response
#### Success Response (200)
- **CreateInstallApprovalRuleResult** (CompleteAutomaticUpdateApprovalRule) - The newly created complete automatic update approval rule.
```

--------------------------------

### ExecuteSPGetInstallableItems

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves a list of installable items based on a provided update revision ID.

```APIDOC
## ExecuteSPGetInstallableItems

### Description
Retrieves a list of installable items based on a provided update revision ID.

### Method
POST

### Endpoint
/ExecuteSPGetInstallableItems

### Parameters
#### Request Body
- **id** (UpdateRevisionId) - Optional - The ID of the update revision to query for installable items.

### Request Example
```json
{
  "id": {
    "example": "UpdateRevisionId object details"
  }
}
```

### Response
#### Success Response (200)
- **ExecuteSPGetInstallableItemsResult** (ArrayOfArrayOfGenericReadableRow) - A structure containing arrays of generic readable rows representing the installable items.

#### Response Example
```json
{
  "ExecuteSPGetInstallableItemsResult": {
    "example": "ArrayOfArrayOfGenericReadableRow object details"
  }
}
```
```

--------------------------------

### ExecuteSPGetInstallableItems

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves a list of installable items from the WSUS server. This is used to determine available updates for clients.

```APIDOC
## ExecuteSPGetInstallableItems

### Description
Retrieves a list of installable items from the WSUS server. This is used to determine available updates for clients.

### Method
SOAP

### Endpoint
Not specified in WSDL message definition.

### Parameters
None explicitly defined in the WSDL message part.

### Request Example
(SOAP request structure would be defined by the WSDL)

### Response
#### Success Response
(Response structure defined by `ExecuteSPGetInstallableItemsSoapOut` WSDL message)
```

--------------------------------

### CreateInstallApprovalRule

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Creates a new install approval rule. This rule specifies that certain updates should be automatically installed.

```APIDOC
## CreateInstallApprovalRule

### Description
Creates a new install approval rule.

### Method
POST

### Endpoint
/wsus/api

### Parameters
#### Request Body
- **parameters** (object) - Required - Contains the request payload for CreateInstallApprovalRule.

### Request Example
```json
{
  "parameters": {
    "__type": "CreateInstallApprovalRule",
    "Rule": {
      "__type": "InstallApprovalRule",
      "RuleId": "string",
      "Name": "string",
      "Criteria": "string"
    }
  }
}
```

### Response
#### Success Response (200)
- **CreateInstallApprovalRuleResult** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "CreateInstallApprovalRuleResult": true
}
```
```

--------------------------------

### CreateInstallApprovalRule

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Creates a new installation approval rule. This operation is used to define new policies for automatically approving and installing updates.

```APIDOC
## CreateInstallApprovalRule

### Description
Creates a new installation approval rule.

### Method
POST

### Endpoint
/wsus/api

### Parameters
#### Request Body
- **CreateInstallApprovalRuleSoapIn** (object) - Required - Input parameters for the operation.
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForComputer

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for all updates on a specified computer, filtered by publication state. This provides a comprehensive view of update installations.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForComputer

### Description
Retrieves installation information for all updates on a specified computer, filtered by publication state. This provides a comprehensive view of update installations.

### Method
POST (SOAP)

### Endpoint
/wsusar

### Parameters
#### Request Body Parameters
- **ComputerId** (string) - Optional - The unique identifier for the computer.
- **updateScopeXml** (string) - Optional - XML defining the scope of updates to consider.
- **preferredCulture** (string) - Optional - The preferred culture for the response.
- **publicationState** (int) - Required - The publication state to filter updates by.

### Response
#### Success Response (200)
- **ExecuteSPGetUpdateInstallationInfoForComputerResult** (ArrayOfGenericReadableRow) - The result of the operation, containing installation information for updates on the specified computer.
```

--------------------------------

### StartWSUSService

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Starts the Windows Server Update Services (WSUS) service.

```APIDOC
## POST /StartWSUSService

### Description
Starts the WSUS service.

### Method
POST

### Endpoint
/StartWSUSService

### Parameters
#### Request Body
- None specified in WSDL.

### Response
#### Success Response (200)
- None specified in WSDL.

### Request Example
```json
{
  "example": "No request body example available"
}
```

### Response Example
```json
{
  "example": "No response body example available"
}

```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForComputer

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for updates on a specific computer.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForComputer

### Description
Retrieves installation information for updates on a specific computer.

### Method
Not specified (SOAP operation)

### Endpoint
Not specified (SOAP operation)

### Parameters
None explicitly defined in this snippet.

### Request Example
(SOAP request structure not provided in source)

### Response
#### Success Response
(Response structure not provided in source)

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForComputer

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for all updates installed on a specific computer. This provides a detailed view of the update history for a given machine.

```APIDOC
## POST ExecuteSPGetUpdateInstallationInfoForComputer

### Description
Retrieves installation information for all updates installed on a specific computer. This provides a detailed view of the update history for a given machine.

### Method
POST

### Endpoint
/ApiRemotingWebService/ExecuteSPGetUpdateInstallationInfoForComputer

### Parameters
#### Request Body
- **parameters** (object) - Required - The input parameters for the operation.

### Request Example
{
  "example": "{\"parameters\": {}}"
}

### Response
#### Success Response (200)
- **ExecuteSPGetUpdateInstallationInfoForComputerResult** (object) - The result of the operation, containing update installation information for the computer.

#### Response Example
{
  "example": "{\"ExecuteSPGetUpdateInstallationInfoForComputerResult\": {}}"
}
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForUpdate

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for a specific update.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForUpdate

### Description
Retrieves installation information for a specific update.

### Method
Not specified (SOAP operation)

### Endpoint
Not specified (SOAP operation)

### Parameters
None explicitly defined in this snippet.

### Request Example
(SOAP request structure not provided in source)

### Response
#### Success Response
(Response structure not provided in source)

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### ExecuteSPGetInstallableItems

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves a list of installable items for updates. This operation is part of the WSUS API for managing update deployments.

```APIDOC
## ExecuteSPGetInstallableItems

### Description
Retrieves a list of installable items for updates. This operation is part of the WSUS API for managing update deployments.

### Method
POST

### Endpoint
/ApiRemotingWebService

### Parameters
#### Request Body
- **parameters** (object) - Required - Contains parameters for the operation.
  - **updateIDs** (Array of strings) - Required - A list of update identifiers.

### Request Example
```json
{
  "parameters": {
    "updateIDs": ["guid1", "guid2"]
  }
}
```

### Response
#### Success Response (200)
- **ExecuteSPGetInstallableItemsResult** (object) - Contains the result of the operation.
  - **InstallableItems** (Array of objects) - A list of installable items.
    - **UpdateID** (string) - The ID of the update.
    - **IsInstallable** (boolean) - Indicates if the update is installable.
    - **RejectionReason** (string) - The reason for rejection, if any.

#### Response Example
```json
{
  "ExecuteSPGetInstallableItemsResult": {
    "InstallableItems": [
      {
        "UpdateID": "guid1",
        "IsInstallable": true,
        "RejectionReason": null
      }
    ]
  }
}
```
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForUpdate

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for a specific update on a computer. This is helpful for diagnosing installation issues or verifying update status.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForUpdate

### Description
Retrieves installation information for a specific update on a computer. This is helpful for diagnosing installation issues or verifying update status.

### Method
POST (SOAP)

### Endpoint
/wsusar

### Parameters
#### Request Body Parameters
- **updateId** (guid) - Required - The unique identifier of the update.
- **computerTargetScopeXml** (string) - Optional - XML defining the scope of computers to query.

### Response
#### Success Response (200)
- **ExecuteSPGetUpdateInstallationInfoForUpdateResult** (ArrayOfGenericReadableRow) - The result of the operation, containing installation information for the specified update.
```

--------------------------------

### ExecuteSPGetInstallableItems

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves a list of installable items (updates) from the WSUS server. This operation is used to query available updates.

```APIDOC
## POST /ExecuteSPGetInstallableItems

### Description
Retrieves a list of installable items (updates) from the WSUS server.

### Method
POST

### Endpoint
/ExecuteSPGetInstallableItems

### Parameters
#### Request Body
- **ExecuteSPGetInstallableItemsSoapIn** (object) - Required - The input parameters for the ExecuteSPGetInstallableItems operation.

### Request Example
```json
{
  "ExecuteSPGetInstallableItemsSoapIn": {
    "parameters": "..."
  }
}
```

### Response
#### Success Response (200)
- **ExecuteSPGetInstallableItemsSoapOut** (object) - The output of the ExecuteSPGetInstallableItems operation.

#### Response Example
```json
{
  "ExecuteSPGetInstallableItemsSoapOut": {
    "result": "..."
  }
}
```
```

--------------------------------

### CreateInstallApprovalRule

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Creates an install approval rule. This operation is part of the API Remoting Web Service.

```APIDOC
## POST /ApiRemotingWebService

### Description
Creates an install approval rule.

### Method
POST

### Endpoint
/ApiRemotingWebService

### Parameters
#### Request Body
- **Rule** (object) - Required - The install approval rule to create.

### Response
#### Success Response (200)
- **Result** (boolean) - Indicates if the operation was successful.

### Request Example
```json
{
  "Rule": { ... }
}
```

### Response Example
```json
{
  "Result": true
}
```
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForComputer

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for updates on a specific computer. This operation is part of the ApiRemotingWebService.

```APIDOC
## POST ExecuteSPGetUpdateInstallationInfoForComputer

### Description
Retrieves installation information for updates on a specific computer. This operation is part of the ApiRemotingWebService.

### Method
POST

### Endpoint
/ApiRemotingWebService

### Parameters

### Request Body
- **(literal)** - Required - The request body is used to pass parameters for the operation.

### Response
#### Success Response (200)
- **(literal)** - The response body contains the results of the operation.
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForUpdate

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for a specific update. This operation is part of the ApiRemotingWebService.

```APIDOC
## POST ExecuteSPGetUpdateInstallationInfoForUpdate

### Description
Retrieves installation information for a specific update. This operation is part of the ApiRemotingWebService.

### Method
POST

### Endpoint
/ApiRemotingWebService

### Parameters

### Request Body
- **(literal)** - Required - The request body is used to pass parameters for the operation.

### Response
#### Success Response (200)
- **(literal)** - The response body contains the results of the operation.
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForTargetGroup

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves detailed installation information for updates within a specified target group. This provides granular data on the installation status of each update for each computer in the group.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForTargetGroup

### Description
Retrieves detailed installation information for updates within a specified target group. This provides granular data on the installation status of each update for each computer in the group.

### Method
SOAP

### Endpoint
[Not specified in source]

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **targetGroupName** (string) - Required - The name of the target group.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tns:ExecuteSPGetUpdateInstallationInfoForTargetGroup>
         <targetGroupName>TargetGroupNameHere</targetGroupName>
      </tns:ExecuteSPGetUpdateInstallationInfoForTargetGroup>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **UpdateInstallationInfo** (Array) - An array of objects, each containing detailed installation information for an update on a specific computer within the target group.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tns:ExecuteSPGetUpdateInstallationInfoForTargetGroupResponse>
         <UpdateInstallationInfo>
            <ComputerId>COMPUTER_ID_1</ComputerId>
            <UpdateId>UPDATE_ID_1</UpdateId>
            <Status>Installed</Status>
            <InstalledOn>2023-01-01T10:00:00Z</InstalledOn>
         </UpdateInstallationInfo>
         <UpdateInstallationInfo>
            <ComputerId>COMPUTER_ID_1</ComputerId>
            <UpdateId>UPDATE_ID_2</UpdateId>
            <Status>Pending</Status>
         </UpdateInstallationInfo>
      </tns:ExecuteSPGetUpdateInstallationInfoForTargetGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForComputer

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for updates on a specific computer. This operation is part of the WSUS WSDL.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForComputer

### Description
Retrieves installation information for updates on a specific computer.

### Method
SOAP

### Endpoint
Not specified in WSDL

### Parameters
#### Request Body
- **parameters** (tns:ExecuteSPGetUpdateInstallationInfoForComputer) - Required - The input parameters for the operation.

### Response
#### Success Response
- **parameters** (tns:ExecuteSPGetUpdateInstallationInfoForComputerResponse) - The response containing the update installation information.
```

--------------------------------

### Guid (Get) Method

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-pla/a83c07cf-df6d-4f1b-9b47-9cb0cf78cb1c

The Guid (Get) method retrieves the Guid property, which serves as the PLA-UID. It returns a GUID representing the PLA-UID.

```APIDOC
## Guid (Get) (Opnum 9)

### Description
Retrieves the Guid property, which is used as a PLA-UID.

### Method
propget

### Endpoint
Not applicable (this is an RPC-style method)

### Parameters
#### Out Parameters
- **guid** (GUID*) - Receives the PLA-UID. Any PLA-UID other than the value 0000-0000-0000-0000-0000-0000-0000-0000 is potentially a valid PLA-UID for a provider. Consequently, any value other than 0000-0000-0000-0000-0000-0000-0000-0000 will be considered valid for this property.

### Return Values
This method MUST return an HRESULT with the severity bit clear on success as specified in [MS-ERREF]; otherwise, it MUST return one of the errors as defined in 2.2.1 or one of the errors as defined in [MS-ERREF] section 2.1.
```

--------------------------------

### StartBackup

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-sfmwa/adc75e67-cb3d-4bd8-bbf4-e65c3151895c

Initiates a backup process for a specified device or the entire server.

```APIDOC
## StartBackup

### Description
Initiates a backup process. This can be used to start a backup for a specific device or for the entire server, depending on the parameters provided. This operation is part of the Device Management service.

### Method
POST

### Endpoint
/DeviceManagement/StartBackup

### Parameters
#### Request Body
- **StartBackupRequest** (object) - Required - The request body specifying what to back up.

### Request Example
```json
{
  "DeviceId": "GUID-1234" 
}
```

### Response
#### Success Response (200)
- **StartBackupResponse** (object) - Indicates the status of the backup initiation.

#### Response Example
```json
{
  "Status": "BackupInitiated"
}
```
```

--------------------------------

### StartSubscriptionManually

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Manually starts the WSUS subscription process. This operation can be used to initiate an update synchronization on demand.

```APIDOC
## StartSubscriptionManually

### Description
Manually starts the WSUS subscription process. This operation can be used to initiate an update synchronization on demand.

### Method
SOAP

### Endpoint
Not specified in source

### Parameters
#### Request Body
- **parameters** (StartSubscriptionManually) - Required - The input parameters for the StartSubscriptionManually operation.

### Request Example
```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tns:StartSubscriptionManually xmlns:tns="http://tempuri.org/">
      <!-- Parameter elements go here -->
    </tns:StartSubscriptionManually>
  </soap:Body>
</soap:Envelope>
```

### Response
#### Success Response (200)
- **parameters** (StartSubscriptionManuallyResponse) - The response from the StartSubscriptionManually operation.

### Response Example
```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tns:StartSubscriptionManuallyResponse xmlns:tns="http://tempuri.org/">
      <!-- Response elements go here -->
    </tns:StartSubscriptionManuallyResponse>
  </soap:Body>
</soap:Envelope>
```
```

--------------------------------

### Guid (Get) Method Signature

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-pla/a83c07cf-df6d-4f1b-9b47-9cb0cf78cb1c

This is the method signature for the Guid (Get) operation. It retrieves the PLA-UID property.

```csharp
[propget] HRESULT Guid(
  [out, retval] GUID* guid
);
```

--------------------------------

### OnboardVirtualDesktop

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Onboards a virtual desktop.

```APIDOC
## OnboardVirtualDesktop

### Description
Onboards a virtual desktop.

### Method
SOAP

### Endpoint
N/A (WSDL operation)

### Parameters
N/A (Defined within WSDL messages)

### Request Example
N/A (WSDL defines message structure)

### Response
#### Success Response
- **parameters** (tns:OnboardVirtualDesktopResponse) - The response indicating the result of onboarding.
```

--------------------------------

### Version Zero Configuration File Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-gpfr/3caa2472-39da-4b72-a34d-54df1e208024

This configuration file demonstrates redirection options for user folders. It specifies different server paths for 'My Documents' and 'Desktop' based on security identifiers.

```ini
[FolderStatus]
My Documents=11
My Pictures=2
Desktop=11
[My Documents]
S-1-1-0=\\fileserver1\%USERNAME%\My Documents
S-1-2-3=\\fileserver2\%USERNAME%\My Documents
[Desktop]
S-1-1-0=\\fileserver1\%USERNAME%\Desktop

```

--------------------------------

### Hidden Updates Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusss/2dedbd00-fbb7-46ee-8ee0-aec9bd1ecd2a

This snippet demonstrates the HiddenUpdates section, which contains GUIDs of hidden updates. It shows two example GUIDs.

```xml
<HiddenUpdates>
  <guid>9a9bafe2-fbfc-4b0b-8479-49a2bb08cd5a</guid>
  <guid>6c9d9217-0e1d-434a-a938-d9918703c361</guid>
</HiddenUpdates>
```

--------------------------------

### ExecuteSPGetUpdateInstallationInfoForUpdate

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Retrieves installation information for a specific update. This operation is defined within the WSUS WSDL.

```APIDOC
## ExecuteSPGetUpdateInstallationInfoForUpdate

### Description
Retrieves installation information for a specific update.

### Method
SOAP

### Endpoint
Not specified in WSDL

### Parameters
#### Request Body
- **parameters** (tns:ExecuteSPGetUpdateInstallationInfoForUpdate) - Required - The input parameters for the operation.

### Response
#### Success Response
- **parameters** (tns:ExecuteSPGetUpdateInstallationInfoForUpdateResponse) - The response containing the update installation information.
```

--------------------------------

### Guid (Get)

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-pla/ebd49d76-5e50-4dd3-869c-8bba6eba42f7

Retrieves the Guid property of the trace provider.

```APIDOC
## Guid (Get)

### Description
Retrieves the Guid property of the trace provider.

### Method
GET

### Endpoint
/providers/{providerId}/guid

### Parameters
#### Path Parameters
- **providerId** (string) - Required - The unique identifier of the trace provider.

### Response
#### Success Response (200)
- **guid** (string) - The GUID of the trace provider.
```

--------------------------------

### StartAsyncProvisioning

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-ipamm2/4bf02d14-efe4-4b36-af11-3dd0b77cf087

Starts asynchronous provisioning.

```APIDOC
## StartAsyncProvisioning

### Description
Starts asynchronous provisioning.

### Method
Not specified in source

### Endpoint
Not specified in source
```

--------------------------------

### StartSubscriptionManuallyForCategoryOnly

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Manually starts the WSUS subscription process for a specific category only. This allows for targeted synchronization of updates.

```APIDOC
## StartSubscriptionManuallyForCategoryOnly

### Description
Manually starts the WSUS subscription process for a specific category only. This allows for targeted synchronization of updates.

### Method
SOAP

### Endpoint
Not specified in source

### Parameters
#### Request Body
- **parameters** (StartSubscriptionManuallyForCategoryOnly) - Required - The input parameters for the StartSubscriptionManuallyForCategoryOnly operation.

### Request Example
```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tns:StartSubscriptionManuallyForCategoryOnly xmlns:tns="http://tempuri.org/">
      <!-- Parameter elements go here -->
    </tns:StartSubscriptionManuallyForCategoryOnly>
  </soap:Body>
</soap:Envelope>
```

### Response
#### Success Response (200)
- **parameters** (StartSubscriptionManuallyForCategoryOnlyResponse) - The response from the StartSubscriptionManuallyForCategoryOnly operation.

### Response Example
```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tns:StartSubscriptionManuallyForCategoryOnlyResponse xmlns:tns="http://tempuri.org/">
      <!-- Response elements go here -->
    </tns:StartSubscriptionManuallyForCategoryOnlyResponse>
  </soap:Body>
</soap:Envelope>
```
```

--------------------------------

### Client Get Device Capability Response Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpexps/5d69422d-0a50-40d4-bb4e-f4aa78151aab

This example shows the byte structure for a client's Get Device Capability Response, including InterfaceId, MessageId, and response-specific fields.

```text
00000000 00 00 00 00 00 00 00 00 00 06 00 00 00 00 00 00
00000010 00 00 00 00

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
00 06 00 00 -> ReturnValue = 0x600
00 00 00 00 -> cbOutputBufferSize = 0
           -> OutputBuffer (variable size=0)
00 00 00 00 -> Result = S_OK
```

--------------------------------

### StartSubscriptionManuallyForCategoryOnly

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wsusar/1d3fc01a-d581-4ee6-bde6-a6f4e2b68375

Starts a manual subscription specifically for a category, without including other update types. This operation does not require any parameters.

```APIDOC
## StartSubscriptionManuallyForCategoryOnly

### Description
Starts a manual subscription specifically for a category.

### Method
POST

### Endpoint
/StartSubscriptionManuallyForCategoryOnly

### Parameters
None

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
An empty response indicates successful execution.

#### Response Example
```json
{
  "example": "No response body"
}
```
```

--------------------------------

### Example: Calculating Bandwidth Priority from Priority Charges

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpedyc/f6bf0f0b-577c-4e92-bd7c-e7f2953c0613

This example shows how to calculate the bandwidth distribution (BandwidthPriorityX) when given the PriorityCharge values, using the previously calculated values for a 70/20/7/3 distribution.

```plaintext
 Base = 936 * 3276 * 9362 * 21845 /
     (3276 * 9362 * 21845 + 936 * 9362 * 
     21845 + 936 * 3276 * 21845 + 936 * 
     3276 * 9362) = 655
            
 BandwidthPriority0 = 655/936 = 70%
 BandwidthPriority1 = 655/3276 = 20%
 BandwidthPriority2 = 655/9362 = 7%
 BandwidthPriority3 = 655/21845 = 3%
```

--------------------------------

### IAddInMetadataInstall.DownloadInstallAddIn

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wcfesan/32b05330-73d8-4347-a6f0-c36893f95eba

Downloads and then installs the specified add-in. This combines download and installation steps.

```APIDOC
## IAddInMetadataInstall.DownloadInstallAddIn

### Description
Downloads and installs the given add-in.

### Method
Not specified (likely a method call within a service interface)

### Endpoint
Not applicable (interface method)

### Parameters
- **AddInId** (string) - The ID of the add-in to download and install.

### Request Example
None provided.

### Response
None explicitly defined in this context.
```

--------------------------------

### IUpdate::Deadline

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-uamg/794471bd-6b5e-48c7-a904-53a8e019cd66

Gets the deadline for installing the update. This property specifies the latest date by which the update should be installed.

```APIDOC
## IUpdate::Deadline

### Description
Gets the deadline for installing the update.

### Method
Opnum 13
```

--------------------------------

### Example SubscriberName Field

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-mmsp/8826b7ec-eb64-449d-98e4-368c2a9b1969

An example illustrating the format of the subscriberName field, including the client token, GUID, and version information.

```text
NSPlayer/4.1.0.3928; {68c0a090-8797-11d2-a2b3-00a0c9b60551}
```

--------------------------------

### IUpdate::InstallationBehavior

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-uamg/42660853-4316-492c-b233-09d52b0e3f28

Retrieves a description of the installation behavior of the update.

```APIDOC
## IUpdate::InstallationBehavior (Opnum 22)

### Description
Retrieves a description of the installation behavior of the update.

### Method
This is a method call within the IUpdate interface.

### Parameters
#### Out Parameters
* **retval** (InstallationBehavior**) - The output parameter that will contain an InstallationBehavior instance defining the behavior of the installation operation for this update.

### Return Values
The method MUST return information in an HRESULT data structure. The severity bit in the structure identifies the following conditions:
  * If the severity bit is set to 0, the method completed successfully.
  * If the severity bit is set to 1, the method failed and encountered a fatal error.

### Exceptions Thrown
No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

### Server Behavior
The server SHOULD return the value of the InstallationBehavior ADM element.
```
Tokens:
Raw