Test-SCAPolicy

Test-SCAPolicy

SYNOPSIS

Validates an SCA user access policy

SYNTAX

Test-SCAPolicy [-policyId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Triggers a validation process for a user access policy, confirming the cloud roles and identities it references can still be resolved.

The operation is asynchronous. The status of the job which was started is returned; pass its job_id to Get-SCAJobStatus to check on it again later.

EXAMPLES

Example 1

Test-SCAPolicy -policyId aws_sso_1234abcd-123a-1ab2-a12b-12f1b179e053

Starts validation of the specified policy.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-policyId

The unique ID of the policy.

Type: String
Parameter Sets: (All)
Aliases: policy_id

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

Vendor documentation states the API which this command uses will be deprecated in the near future.