PropertyCmdletProviderIntrinsics.Rename Method

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Rename(String, String, String)	Renames a property on the specified item(s)
Rename(String[], String, String, Boolean, Boolean)	Renames a property on the specified item(s)

Rename(String, String, String)

Renames a property on the specified item(s)

public:
 System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Rename(System::String ^ path, System::String ^ sourceProperty, System::String ^ destinationProperty);

public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Rename (string path, string sourceProperty, string destinationProperty);

member this.Rename : string * string * string -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>

Public Function Rename (path As String, sourceProperty As String, destinationProperty As String) As Collection(Of PSObject)

Parameters

path: String

The path to the item(s) on which the property should be renamed.

sourceProperty: String

The source name of the property to be renamed.

destinationProperty: String

The new name of the property.

Returns

Collection<PSObject>

A PSObject for each item that is the new property after the rename.

Exceptions

ArgumentNullException

If path, sourceProperty, or destinationProperty is null.

ProviderNotFoundException

If the path refers to a provider that could not be found.

DriveNotFoundException

If the path refers to a drive that could not be found.

ItemNotFoundException

If path does not contain glob characters and could not be found.

NotSupportedException

If the provider that the path refers to does not support this operation.

ProviderInvocationException

If the provider threw an exception.

Applies to

Rename(String[], String, String, Boolean, Boolean)

Renames a property on the specified item(s)

public:
 System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Rename(cli::array <System::String ^> ^ path, System::String ^ sourceProperty, System::String ^ destinationProperty, bool force, bool literalPath);

public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Rename (string[] path, string sourceProperty, string destinationProperty, bool force, bool literalPath);

member this.Rename : string[] * string * string * bool * bool -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>

Public Function Rename (path As String(), sourceProperty As String, destinationProperty As String, force As Boolean, literalPath As Boolean) As Collection(Of PSObject)