Share via

Get-SCApplicationSetting

  • Reference
Module:
VirtualMachineManager

Gets application settings for an application or application deployment.

Syntax

Get-SCApplicationSetting
   [-VMMServer <ServerConnection>]
   -ApplicationDeployment <ApplicationDeployment>
   [-Name <String>]
   [<CommonParameters>]
Get-SCApplicationSetting
   [-VMMServer <ServerConnection>]
   -Application <SCApplication>
   [-Name <String>]
   [<CommonParameters>]
Get-SCApplicationSetting
   [-VMMServer <ServerConnection>]
   -ApplicationPackage <ApplicationPackage>
   [-Name <String>]
   [<CommonParameters>]

Description

The Get-SCApplicationSetting cmdlet gets application settings for an application or application deployment.

Examples

Example 1: Get all application settings for an application deployment

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $AppDeployment = Get-SCApplicationDeployment -ApplicationProfile $AppProfile -Name "SvcWebDeployment01"
PS C:\> $AppSetting = Get-SCApplicationSetting -ApplicationDeployment $AppDeployment

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

The second command gets the application deployment object named SvcWebDeployment01 for the application profile stored in $AppProfile and stores the object in the $AppDeployment variable.

The last command gets the application setting objects for the application deployment stored in $AppDeployment and stores the objects in the $AppSetting array (this example assumes that there are multiple settings for the application).

Example 2: Get all application settings for an application installed on a virtual machine

PS C:\> $VM = Get-SCVirtualMachine "VM01"
PS C:\> $Apps = Get-SCApplication -VM $VM
PS C:\> $AppSetting = Get-SCApplicationSetting -ApplicationDeployment $Apps[0]

The first command gets the virtual machine object named VM01 and stores the object in the $VM variable.

The second command gets the application objects installed on VM01 and stores the objects in the $Apps variable.

The last command gets the application settings for the first application stored in $Apps.

Parameters

-Application

Specifies an application object.

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

-ApplicationDeployment

Specifies an application deployment object.

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

-ApplicationPackage

Specifies an application package object.

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

-VMMServer

Specifies a VMM server object.

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

Outputs

ApplicationSetting

This cmdlet returns an ApplicationSetting object.