Get-SCSQLDeployment
Gets a SQL Server deployment.
Syntax
SQLProfile
Get-SCSQLDeployment
-SQLProfile <SQLProfile>
[-VMMServer <ServerConnection>]
[-Name <String>]
[<CommonParameters>]
SQLConfigurationFile
Get-SCSQLDeployment
[-VMMServer <ServerConnection>]
[-SQLConfigurationFile <Script>]
[<CommonParameters>]
ID
Get-SCSQLDeployment
-ID <Guid>
[-VMMServer <ServerConnection>]
[<CommonParameters>]
Description
The Get-SCSQLDeployment cmdlet gets a Microsoft SQL Server deployment.
Examples
Example 1: Get a specific SQL Server deployment object from an existing SQL Server profile
PS C:\> $SQLProfile = Get-SCSQLProfile -Name "SQLProfile01"
PS C:\> Get-SCSQLDeployment -SQLProfile $SQLProfile -Name "SQL Deployment 01"
The first command gets the SQL Server profile named SQLProfile01, and then stores that object in the $SQLProfile variable. This command uses the Get-SCSQLProfile cmdlet.
The second command gets the SQL Server deployment named SQL Deployment 01 from the SQL Profile stored in $SQLProfile.
Parameters
-ID
Specifies the unique ID of the deployment that this cmdlet gets.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ID
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the SQL Server deployment that this cmdlet gets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SQLProfile
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SQLConfigurationFile
Specifies the configuration file for the SQL Server deployment that this cmdlet gets.
Parameter properties
| Type: | Script |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SQLConfigurationFile
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SQLProfile
Specifies the SQL Server profile from which this cmdlet gets a SQL Server deployment.
Parameter properties
| Type: | SQLProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SQLProfile
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies the VMM server on which this cmdlet operates.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
SQLDeployment
This cmdlet returns a SQLDeployment object.