Share via

Set-SCApplicationProfile

  • Reference
Module:
VirtualMachineManager

Modifies the properties of an application profile.

Syntax

Set-SCApplicationProfile
   [-VMMServer <ServerConnection>]
   [-ApplicationProfile] <ApplicationProfile>
   [-Name <String>]
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-Tag <String>]
   [-CompatibilityType <String>]
   [-EnforceCompatibilityType]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCApplicationProfile cmdlet modifies the properties of an application profile.

Examples

Example 1: Change the name of an application profile

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> Set-SCApplicationProfile -ApplicationProfile $AppProfile -Name "StockWebApp"

The first command gets the application profile object named SvcWebAppProfile01 and stores the object in the $AppProfile variable.

The second command changes the name of the application profile object stored in $AppProfile to StockWebApp.

Example 2: Change the description of an application profile

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "StockWebApp"
PS C:\> Set-SCApplicationProfile -ApplicationProfile $AppProfile -Description "Application profile to use when deploying the stock application web servers."

The first command gets the application profile object named StockWebApp and stores the object in the $AppProfile variable.

The second command changes the description of the application profile object stored in $AppProfile to "Application profile to use when deploying the stock application web servers."

Parameters

-ApplicationProfile

Specifies an application profile object.

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

-CompatibilityType

Specifies the deployment types with which an application profile is compatible. The acceptable values for this parameter are:

  • General
  • SQLApplicationHost
  • WebApplicationHost
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

States a description for the specified object.

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

-EnforceCompatibilityType

Indicates that artifacts from an application profile which is not compatible with the value provided for the CompatibilityType parameter are removed.

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

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

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

-Owner

Specifies the owner of a VMM object in the form of a valid domain user account.

  • Example format: -Owner "Contoso\PattiFuller"
  • Example format: -Owner "PattiFuller@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

-Tag

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.

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

-UserRole

Specifies a user role object.

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

-VMMServer

Specifies a VMM server object.

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