Share via

Get-SCSQLDeployment

  • Reference
Module:
VirtualMachineManager

Gets a SQL Server deployment.

Syntax

Get-SCSQLDeployment
   [-VMMServer <ServerConnection>]
   -SQLProfile <SQLProfile>
   [-Name <String>]
   [<CommonParameters>]
Get-SCSQLDeployment
   [-VMMServer <ServerConnection>]
   [-SQLConfigurationFile <Script>]
   [<CommonParameters>]
Get-SCSQLDeployment
   [-VMMServer <ServerConnection>]
   -ID <Guid>
   [<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.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the SQL Server deployment that this cmdlet gets.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SQLConfigurationFile

Specifies the configuration file for the SQL Server deployment that this cmdlet gets.

Type:Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SQLProfile

Specifies the SQL Server profile from which this cmdlet gets a SQL Server deployment.

Type:SQLProfile
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMMServer

Specifies the VMM server on which this cmdlet operates.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

SQLDeployment

This cmdlet returns a SQLDeployment object.