en-US/rename-me-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-OrchBucketItem</command:name> <command:verb>Remove</command:verb> <command:noun>OrchBucketItem</command:noun> <maml:description> <maml:para>Removes files and items from UiPath Orchestrator storage buckets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OrchBucketItem cmdlet removes files and items stored within UiPath Orchestrator storage buckets. This cmdlet supports single file deletion, multiple file deletion, wildcard patterns, and recursive deletion operations.</maml:para> <maml:para>Before removing items from buckets, you must navigate to the target folder using Set-Location (cd), or specify the target folders using the -Path parameter. If you attempt to run this cmdlet without being in a folder context, you will receive an error. Since deletion operations are irreversible, it is strongly recommended to use the -WhatIf parameter to preview operations before execution.</maml:para> <maml:para>Storage buckets provide file storage capabilities for automation processes, allowing them to store, retrieve, and manage files during execution. This cmdlet is essential for maintaining clean storage environments and managing file lifecycles in automation workflows. Primary Endpoint: DELETE /odata/Buckets({bucketId})/UiPath.Server.Configuration.OData.DeleteFile OAuth required scopes: OR.Administration Required permissions: Buckets.View and BlobFiles.Delete</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-OrchBucketItem</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path <String[]></maml:name> <maml:description> <maml:para>Specifies the path(s) to the target folder(s) containing the buckets from which items will be removed. Use this parameter to remove bucket items from specific folders without changing your current location.</maml:para> <maml:para>`yaml Type: String[] Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: True `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse [<SwitchParameter>]</maml:name> <maml:description> <maml:para>Removes items from subdirectories recursively. Use this parameter when you need to clean up bucket contents with deep hierarchical structures.</maml:para> <maml:para>`yaml Type: SwitchParameter Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth <UInt32></maml:name> <maml:description> <maml:para>Specifies the maximum depth for recursive removal operations. Only effective when -Recurse is used. This parameter helps prevent unintended deletion of deeply nested items.</maml:para> <maml:para>`yaml Type: UInt32 Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name <String[]></maml:name> <maml:description> <maml:para>Specifies the name(s) of the storage bucket(s) from which items will be removed. Supports wildcard patterns and can target multiple buckets simultaneously.</maml:para> <maml:para>`yaml Type: String[] Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: True `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FullPath <String[]></maml:name> <maml:description> <maml:para>Specifies the full path(s) of specific files within the bucket to be removed. Supports wildcard patterns for batch deletion of files matching specific criteria.</maml:para> <maml:para>`yaml Type: String[] Parameter Sets: (All) Aliases: </maml:para> <maml:para>Required: False Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: True `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Confirm [<SwitchParameter>]</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet. Since deletion operations are irreversible, it is recommended to use this parameter when working with critical data.</maml:para> <maml:para>`yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf</maml:para> <maml:para>Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WhatIf [<SwitchParameter>]</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs without performing the actual deletion. Use this parameter to preview the impact of removal operations before execution.</maml:para> <maml:para>`yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi</maml:para> <maml:para>Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProgressAction <ActionPreference></maml:name> <maml:description> <maml:para>Controls how progress information is displayed during command execution. Use 'SilentlyContinue' to suppress progress display when removing large numbers of items.</maml:para> <maml:para>`yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga</maml:para> <maml:para>Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False `</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe bucket names or file paths to this cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>UiPath.PowerShell.Entities.BucketItem</maml:name> </dev:type> <maml:description> <maml:para>You can pipe bucket item objects from Get-OrchBucketItem directly to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet does not generate output. Use Get-OrchBucketItem to verify deletion results.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Permanent Deletion: Removed items cannot be recovered. Always create backups before removing critical data. - Parameter Restrictions: Some parameter combinations have limitations. -Recurse and -FullPath may have specific interaction rules. - Permission Requirements: Requires bucket edit permissions and file deletion permissions in the target folder. - Batch Operations: When removing multiple items, consider network latency and system load implications. - Error Handling: Attempting to remove non-existent files will result in errors. Use error handling mechanisms in scripts. - Wildcard Support: File patterns like .txt, .log, report_* are supported for efficient bulk operations. - Context Dependency: This cmdlet requires proper folder context or explicit path specification.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Basic file removal with wildcard patterns and preview</maml:title> <dev:code></dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2: Cross-folder removal with -Path parameter -----</maml:title> <dev:code></dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 3: Recursive removal with confirmation --------</maml:title> <dev:code></dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-OrchBucketItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-OrchBucketItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-OrchBucketItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-OrchBucket</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-OrchBucket</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>UiPath Orchestrator Documentation</maml:linkText> <maml:uri>https://docs.uipath.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |