MSFT_HgsGuardian class

Article
05/31/2018

The principal to whom key rights can be assigned.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("HgsClientWmi"), ClassVersion("1.0"), AMENDMENT]
class MSFT_HgsGuardian
{
  string  Name;
  uint8   SigningCertificate[];
  uint8   EncryptionCertificate[];
  string  EncryptionCertificateSignature;
  string  EncryptionCertificateSignatureAlgorithm;
  boolean HasPrivateSigningKey;
};

Members

The MSFT_HgsGuardian class has these types of members:

Methods
Properties

Methods

The MSFT_HgsGuardian class has these methods.

Method	Description
Export	Exports a guardian to an XML file.
Import	Imports a guardian from an XML file.
NewByAcceptCertificates	Creates a guardian.
NewByCertificateThumbprints	Creates a new Guardian by using the certificates identified by the specified thumbprints.
NewByGenerateCertificates	Creates a guardian and a self-signed certificate.
Remove	Removes a guardian that was persisted on this machine.

Properties

The MSFT_HgsGuardian class has these properties.

EncryptionCertificate

Data type: uint8 array
Access type: Read-only

Gets a list of the encryption certificates.

EncryptionCertificateSignature

Data type: string
Access type: Read-only

Gets the encryption certificate signature.

EncryptionCertificateSignatureAlgorithm

Data type: string
Access type: Read-only

Gets the encryption certificate signature algorithm.

HasPrivateSigningKey

Data type: boolean
Access type: Read-only

Returns true if this guardian can be used as an owner for a key protector; otherwise, false.

Name

Data type: string
Access type: Read-only
Qualifiers: key

Gets the friendly name.

SigningCertificate

Data type: uint8 array
Access type: Read-only

Gets a list of the signing certificates.

Requirements


Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016
Namespace	Root\Microsoft\Windows\Hgs
MOF	HgsClientWmi.mof
DLL	HgsClientWmi.dll

Share via