Export AzDevOpsRetentionSettings

Export-AzDevOpsRetentionSettings

SYNOPSIS

Export retention settings for a project to a JSON file.

SYNTAX

JsonFile

Export-AzDevOpsRetentionSettings -Project <String> [-OutputPath <String>] [<CommonParameters>]

PassThru

Export-AzDevOpsRetentionSettings -Project <String> [-PassThru] [<CommonParameters>]

DESCRIPTION

Export retention settings for a project to a JSON file from Azure DevOps REST API.

EXAMPLES

EXAMPLE 1

Get-AzDevOpsRetentionSettings -Project 'MyProject' -OutputPath 'C:\Temp\'

PARAMETERS

-Project

The project to get retention settings for.

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputPath

The path to export the retention settings to.

Type: String
Parameter Sets: JsonFile
Aliases:

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

-PassThru

If set, the function will return the retention settings as objects instead of writing them to a file.

Type: SwitchParameter
Parameter Sets: PassThru
Aliases:

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

NOTES

This function requires a connection to Azure DevOps. See Connect-AzDevOps for more information.

RELATED LINKS