Disable-HgsAttestationPolicy

Disables an attestation policy in HGS.

Syntax

Disable-HgsAttestationPolicy
       [-Name] <String>
       [-PolicyVersion <PolicyVersion>]
       [-Stage]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-HgsAttestationPolicy cmdlet disables an attestation policy in the Host Guardian Service (HGS). Specify the policy to disable by name.

Examples

Example 1: Disable a policy

PS C:\> Disable-HgsAttestationPolicy -Name "BaselineTpmPolicy16"

This command disables the attestation policy named BaselineTpmPolicy16. After you run this command, any guarded host that requires this policy can no longer obtain new attestation certificates.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the policy that this cmdlet disables.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-PolicyVersion

Reserved for future use.

Type:PolicyVersion
Accepted values:None, PolicyVersion1503, PolicyVersion1704
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Stage

Reserved for future use.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

AttestationPolicyInfo

This cmdlet returns an AttestationPolicyInfo object.