Get-WebConfigurationProperty
Get-WebConfigurationProperty
Gets an IIS configuration property at the specified path.
Syntax
Parameter Set: Default
Get-WebConfigurationProperty [-Filter] <String[]> [[-PSPath] <String[]> ] -Name <String[]> [-Clr <String> ] [-Location <String[]> ] [-Recurse] [ <CommonParameters>]
Detailed Description
The Get-WebConfigurationProperty cmdlet is similar to the Get-WebConfiguration cmdlet, but Get-WebConfigurationProperty supports globbing (wildcards).
Parameters
-Clr<String>
Version of the .NET framework in the form vn.n, such as v4.0 or v2.0. The default is v4.0. This parameter is used only when PSPath is set to either Machine or Machine/Webroot. If PSPath is not set to one of these values and the Clr parameter is set, PowerShell ignores the value of Clr and returns a warning.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Filter<String[]>
Specifies the IIS configuration section or an XPath query that returns a configuration element.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Location<String[]>
The location of the configuration setting. Location tags are frequently used for configuration settings that must be set more precisely than per application or per virtual directory. For example, a setting for a particular file or directory could use a location tag. Location tags are also used if a particular section is locked. In such an instance, the configuration system would have to use a location tag in one of the parent configuration files.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
The name of the property to get.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PSPath<String[]>
Specifies the configuration path. This can be either an IIS configuration path in the format computer name/webroot/apphost, or the IIS module path in this format IIS:\sites\Default Web Site.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Recurse
When theRecurseparameter is specified, the cmdlet returns the properties of nodes contained within the hierarchy of the specified node.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
- PSObject
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSObject
Examples
-------------- EXAMPLE 1: Return the Default Documents for the Default Web Site --------------
Returns a list of the default documents associated with the Default Web Site.
Default.htm
Default.asp
Index.htm
Index.html
Iisstart.htm
Default.aspx
C:\PS>Get-WebConfigurationProperty -Filter //defaultDocument/files/add -PSPath 'IIS:\Sites\Default Web Site' -Name value | select value
-------------- EXAMPLE 2: Show handlers mapped to ASPNET_ISAPI.DLL --------------
Demonstrates how to get the handlers mapped to aspnet_isapi.dll.
C:\PS>Get-WebConfigurationProperty //handlers 'IIS:\sites\Default Web Site' -Property Collection[scriptProcessor="*aspnet_isapi.dll"] | select path,name