Skip to content

Get-B1RecycleBin

SYNOPSIS

Queries the Universal DDI Recycle Bin

SYNTAX

Get-B1RecycleBin [[-ResourceName] <String>] [[-ResourceType] <String>] [[-Limit] <Int32>] [[-Offset] <Int32>]
 [[-OrderBy] <String>] [[-Fields] <String[]>] [[-CustomFilters] <Object>] [-CaseSensitive] [-Strict]
 [[-id] <String>] [<CommonParameters>]

DESCRIPTION

This function is used to query the Universal DDI Recycle Bin. This gives you visibility on deleted resources and their context.

EXAMPLES

EXAMPLE 1

Get-B1RecycleBin -Limit "25" -Offset "0" -ResourceName "my.resource.name" -ResourceType "DNS Record"

PARAMETERS

-ResourceName

The name of the resource you would like to filter the recycle bin with

Type: String
Parameter Sets: (All)
Aliases:

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

-ResourceType

Used to filter by Resource Type, such as "record" or "address_block"

Type: String
Parameter Sets: (All)
Aliases:

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

-Limit

Use this parameter to limit the quantity of results returned from the Recycle Bin. The default number of results is 100.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False

-Offset

Use this parameter to offset the results by the value entered for the purpose of pagination

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-OrderBy

Optionally return the list ordered by a particular value. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default.

Type: String
Parameter Sets: (All)
Aliases:

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

-Fields

Specify a list of fields to return. The default is to return all fields.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-CustomFilters

Accepts either an Object, ArrayList or String containing one or more custom filters. See here for usage: https://ibps.readthedocs.io/en/latest/#-customfilters

Type: Object
Parameter Sets: (All)
Aliases:

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

-CaseSensitive

Use Case Sensitive matching. By default, case-insensitive matching both for -Strict matching and regex matching.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Strict

Use strict filter matching. By default, filters are searched using wildcards where possible. Using strict matching will only return results matching exactly what is entered in the applicable parameters.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-id

{{ Fill id Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
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

NOTES