Get-WebConfigurationProperty
Get-WebConfigurationProperty
Gets an IIS configuration property at the specified path.
Syntax
Get-WebConfigurationProperty -Name <String[]> [-Recurse] [-Location <String[]>] [-Filter] <String[]> [[-PSPath] <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Detailed Description
The Get-WebConfigurationProperty cmdlet is similar to the Get-WebConfiguration cmdlet, but Get-WebConfigurationProperty supports globbing (wildcards).
Parameters
-Name <String[]>
The name of the property to get.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Recurse <SwitchParameter>
When the Recurse parameter is specified, the cmdlet returns the properties of nodes contained within the hierarchy of the specified node.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-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.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
named |
-Filter <String[]>
Specifies the IIS configuration section or an XPath query that returns a configuration element.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
1 |
-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.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
2 |
-WarningAction <ActionPreference>
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-WarningVariable <String>
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Input Type |
PSObject. |
Return Type |
PSObject. |
Notes
Examples
EXAMPLE 1: Return the Default Documents for the Default Web Site
C:\PS>Get-WebConfigurationProperty -Filter //defaultDocument/files/add -PSPath 'IIS:\Sites\Default Web Site' -Name value | select value
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
EXAMPLE 2: Show 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
Demonstrates how to get the handlers mapped to aspnet_isapi.dll.
EXAMPLE 3: List default documents using globbing
IIS:\>Get-WebConfigurationProperty -Filter //defaultDocument/files -PSPath 'IIS:\Sites\Default Web Site' -Property Collection[value="index*"]
This command returns all default documents that start with the string "index". The example uses globbing (wildcard expansion) to achieve this.