Microsoft.AzureStackHCI (preview:2025-12-01)

2025/12/08 • 1 updated methods

OwnershipVouchers_Validate (updated)
Description :  Validates ownership vouchers.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OwnershipVouchers_Validate",
  "$parameters": [
    {
      "#name": "validationRequest",
      "Description": {
        "new": "The content of the action request",
        "old": "Ownership vouchers to be validated."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/locations/{location}/validateOwnershipVouchers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
validationRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
ownershipVoucherDetails:
{
Description: Ownership Voucher Details. ,
Required: True ,
}
[
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
ownershipVoucherValidationDetails:
{
Description: Ownership Voucher Validation Details. ,
Required: True ,
}
[
{
validationStatus:
{
Description: The ownership voucher validation status. ,
Enum:
{
Valid: Voucher evaluated as valid. ,
Invalid: Voucher evaluated as invalid. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
id:
{
Description: FDO guid of the Ownership Voucher. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Name of the manufacturer. ,
Required: False ,
}
string ,
modelName:
{
Description: Name of the model. ,
Required: False ,
}
string ,
version:
{
Description: Version of the Ownership Voucher format ,
Required: False ,
}
string ,
azureMachineId:
{
Description: Azure Machine Id of the Ownership voucher ,
Required: False ,
}
string ,
error:
{
Description: Error details if the validation failed. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}