New-SCSQLProfile

Creates a SQL Server profile.

Syntax

New-SCSQLProfile
   [-VMMServer <ServerConnection>]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-Tag <String>]
   [-SQLProfile <SQLProfile>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The New-SCSQLProfile cmdlet creates a Microsoft SQL Server profile.

Examples

Example 1: Create a SQL Server profile

PS C:\> New-SCSQLProfile -Name "SQLProfile01" -Description "SQL Profile 01" -Tag "Standard SQL Profile"

This command creates a SQL Server profile named SQLProfile01. The command specifies a description and a tag for the profile.

Parameters

-Description

Specifies a description for the new SQL Server profile.

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

-JobVariable

Specifies a variable in which job progress is tracked and stored.

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

-Name

Specifies the name of the new SQL Server profile.

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

-Owner

Specifies the owner of the new SQL Server profile. Specify a valid domain user account in the following formats:

  • Contoso\DavidCh
  • DavidCh@Contoso
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-SQLProfile

Specifies a SQL Server profile object.

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

-Tag

Specifies a word or phrase that this cmdlet associates to an object. You can search for a subset of tags, or you can search for the full set of tags.

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

-UserRole

Specifies the user role for the new SQL Server profile.

Type:UserRole
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

SQLProfile

This cmdlet returns a SQLProfile object.