Get-SCApplicationSetting
Get-SCApplicationSetting
Gets application settings for an application or application deployment.
Syntax
Parameter Set: ApplicationDeployment
Get-SCApplicationSetting -ApplicationDeployment <ApplicationDeployment> [-Name <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Application
Get-SCApplicationSetting -Application <SCApplication> [-Name <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ApplicationPackage
Get-SCApplicationSetting -ApplicationPackage <ApplicationPackage> [-Name <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCApplicationSetting cmdlet gets application settings for an application or application deployment.
Parameters
-Application<SCApplication>
Specifies an application object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ApplicationDeployment<ApplicationDeployment>
Specifies an application deployment object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ApplicationPackage<ApplicationPackage>
Specifies an application package object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- ApplicationSetting
Examples
Example 1: Get all application settings for an application deployment
The first command gets the application profile object named SvcWebAppProfile01, and then 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 then 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.
PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $AppDeployment = Get-SCApplicationDeployment -ApplicationProfile $AppProfile -Name "SvcWebDeployment01"
PS C:\> $AppSetting = Get-SCApplicationSetting -ApplicationDeployment $AppDeployment
Example 2: Get all application settings for an application installed on a virtual machine
The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.
The second command gets the application objects installed on VM01, and then stores the objects in the $Apps variable.
The last command gets the application settings for the first application stored in $Apps.
PS C:\> $VM = Get-SCVirtualMachine "VM01"
PS C:\> $Apps = Get-SCApplication -VM $VM
PS C:\> $AppSetting = Get-SCApplicationSetting -ApplicationDeployment $Apps[0]