Get-SqlCloneImage
Published 24 February 2017
Gets image details from a SQL Clone Server.
Syntax
Get-SqlCloneImage [[-Name] <string>] [<CommonParameters>]
Description
The Get-SqlCloneImage cmdlet gets details of clone images from a SQL Clone Server.
Without parameters, this cmdlet gets details of all images. You can specify a particular image by name or use a wildcard filter.
This cmdlet returns a ImageResource which can be passed to the New-SqlClone cmdlet for creating a clone from the image.
Connect-SqlClone must be called before this cmdlet.
Parameters
-Name
<System.String>
The name of the image. Wildcards are permitted. If no name is specified then details of all images will be returned.
| Aliases | None |
| Required? | false |
| Position? | 0 |
| 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.
-
System.String
The name of the image. Wildcards are permitted. If no name is specified then details of all images will be returned.
Return values
The output type is the type of the objects that the cmdlet emits.
- RedGate.SqlClone.Client.Api.Objects.ImageResource
Examples
---------- EXAMPLE 1 ----------
Get-SqlCloneImage
This command gets details of all images from a SQL Clone Server.
---------- EXAMPLE 2 ----------
Get-SqlCloneImage -Name 'FirstImage'
This command gets details of an image named 'FirstImage' from a SQL Clone Server.
---------- EXAMPLE 3 ----------
Get-SqlCloneImage -Name 'AdventureWorks*'
This command gets details of all images with the prefix 'AdventureWorks' from a SQL Clone Server.
