Set-SCSQLProfile

Modifies the properties of a SQL Server profile.

Description

The Set-SQLProfile cmdlet modifies the properties of a SQL Server profile.

For more information about Set-SQLProfile, type: "Get-Help Set-SQLProfile -online".

Parameters

SQLProfile

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies a SQL Server profile object.

Description

Required? false
Accept Pipeline Input? false
Position? named
States a description for the specified object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

Name

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of a VMM object.

Owner

Required? false
Accept Pipeline Input? false
Position? named
Specifies the owner of a VMM object in the form of a valid domain user account.

Example format: -Owner "Contoso\ReneeLo"
Example format: -Owner "ReneeLo@Contoso"

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

Tag

Required? false
Accept Pipeline Input? false
Position? named
Specifies a word or phrase to associate with an object so that you can search for all objects with the specified set of tags. You can search for a subset of tags, or you can search for the full set of tags.

UserRole

Required? false
Accept Pipeline Input? false
Position? named
Specifies a user role object.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a VMM server object.

Examples

1: Change the name of a SQL Server profile and update its description.
PS C:\> $SQLProfile = Get-SCSQLProfile -Name "SQLProfile01"
PS C:\> Set-SCSQLProfile -SQLProfile $SQLProfile -Name "SQLProfile02" -Description "SQL Profile 02"
The first command gets the SQL Server profile object named SQLProfile01 and stores the object in the $SQLProfile variable.

The second command renames the SQL Server profile stored in $SQLProfile to SQLProfile02 and updates its description.

See Also