Get-SCSQLDeployment
Get-SCSQLDeployment
Gets a SQL Server deployment.
Syntax
Parameter Set: ID
Get-SCSQLDeployment -ID <Guid]> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: SQLConfigurationFile
Get-SCSQLDeployment [-SQLConfigurationFile <Script> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: SQLProfile
Get-SCSQLDeployment -SQLProfile <SQLProfile> [-Name <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCSQLDeployment cmdlet gets a Microsoft SQL Server deployment.
Parameters
-ID<Guid]>
Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a Virtual Machine Manager (VMM) object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SQLConfigurationFile<Script>
Specifies a SQL Server configuration file.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SQLProfile<SQLProfile>
Specifies a SQL Server profile object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
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 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- SQLDeployment
Examples
Example 1: Get a specific SQL Server deployment object from an existing SQL Server profile
The first command gets the SQL Server profile object named SQLProfile01, and then stores the object in the $SQLProfile variable.
The second command gets the SQL Server deployment object named SQL Deployment 01 from the SQL Profile stored in $SQLProfile, and then stores the object in the $SQLDeployment variable.
The third command displays the details of the SQL Server deployment stored in $SQLDeployment.
PS C:\> $SQLProfile = Get-SCSQLProfile -Name "SQLProfile01"
PS C:\> $SQLDeployment = Get-SCSQLDeployment -SQLProfile $SQLProfile -Name "SQL Deployment 01"
PS C:\> $SQLDeployment