PoshIssues

PowerShell module to check, track and fix issues.

View project on GitHub

Read-IssueFix

SYNOPSIS

Reads an IssueFix object from the file system.

SYNTAX

DatabasePath (Default)

Read-IssueFix [-DatabasePath] <String> [-IncludeArchive] [-OnlyArchive] [-isPending] [-isComplete] [-isReady]
 [-isError] [-isCanceled] [-isHold] [-isScheduled] [-WhatIf] [-Confirm] [<CommonParameters>]

Path

Read-IssueFix [-Path] <String> [-isPending] [-isComplete] [-isReady] [-isError] [-isCanceled] [-isHold]
 [-isScheduled] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Reads an IssueFix object from the file system. File must have previousely been written to file system.

EXAMPLES

Example 1

PS C:\> Read-IssueFix -DatabasePath C:\Issues

Reads all issuefix objects from the file/folder based database found at C:\Issues.

PARAMETERS

-DatabasePath

A string path representing the folder to use as a simple database. The IssueFix files will be moved to an Archive folder under the Fixes folder and the filename will be appended with the current datatime. Folders will be created as needed. If the IssueFix has already been saved once, the cmdlet can get the value from the pipeline object.

Type: String
Parameter Sets: DatabasePath
Aliases:

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

-IncludeArchive

Include IssueFix files archived in the database. (all)

Type: SwitchParameter
Parameter Sets: DatabasePath
Aliases:

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

-OnlyArchive

Read just from the database archive.

Type: SwitchParameter
Parameter Sets: DatabasePath
Aliases:

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

-Path

A string path representing the path and file name to current JSON file. If the IssueFix has already been saved once, the cmdlet can get the value from the pipeline object.

Type: String
Parameter Sets: Path
Aliases:

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

-isPending

Switch to return only IssueFix objects where status is Pending.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isComplete

Switch to return only IssueFix objects where status is Complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isReady

Switch to return only IssueFix objects where status is Ready.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isError

Switch to return only IssueFix objects where status is Error.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isCanceled

Switch to return only IssueFix objects where status is Canceled.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isHold

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-isScheduled

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

-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

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

OUTPUTS

IssueFix The fix object(s) read from file system

NOTES