Rename-SqlCloneImage
Published 11 June 2018
Rename-SqlCloneImage
Renames an image.
Syntax
Rename-SqlCloneImage [-Image] <ImageResource> [-NewName] <string> [<CommonParameters>]
Description
The Rename-SqlCloneImage cmdlet renames a SQL Clone image.
Connect-SqlClone must be called before this cmdlet.
Parameters
-Image
<RedGate.SqlClone.Client.Api.Objects.ImageResource>
Specifies the image to rename. The Get-SqlCloneImage cmdlet can be used to get an ImageResource.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| Default Value | None |
| Accept Pipeline Input | true (ByValue) |
| Accept Wildcard Characters | false |
-NewName
<System.String>
Specifies the new name of the image.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | true (ByValue) |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
RedGate.SqlClone.Client.Api.Objects.ImageResource
Specifies the image to rename. The Get-SqlCloneImage cmdlet can be used to get an ImageResource.
-
System.String
Specifies the new name of the image.
Return values
The output type is the type of the objects that the cmdlet emits.
-
None.
You cannot pipe input to this cmdlet.
Examples
---------- EXAMPLE 1 ----------
$ImageToRename = Get-SqlCloneImage -Name 'ImageToRename' Rename-SqlCloneImage -Image $ImageToRename -NewName 'NewName'
This example renames an image with the name 'ImageToRename' to 'NewName'.
