iis-docs
iis-docs copied to clipboard
MicrosoftDocs
Documentation for System.Web.UrlMappingsModule is missing
Issue moved from dotnet/dotnet-api-docs#5020
- Please respond to @gewarren.
From @gewarren on Wednesday, October 21, 2020 3:11:44 AM
Issue moved from MicrosoftDocs/feedback#3158
- Please respond to @rossmpersonal.
From @rossmpersonal on Saturday, October 3, 2020 3:38:06 AM
Describe the bug Documentation for System.Web.UrlMappingsModule is missing.
To Reproduce Steps to reproduce the behavior:
- Go to https://docs.microsoft.com/en-us/dotnet/api/
- Enter System.Web.UrlMappingsModule in the search box.
- See No Results returned
Expected behavior Link to documentation for System.Web.UrlMappingsModule appears.
Screenshots
If applicable, add screenshots to help explain your problem.
Desktop (please complete the following information):
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
Smartphone (please complete the following information):
- MacBook Pro
- 10.15.7 -Safari
- Version 14.0
Additional context Add any other context about the problem here.
Issue moved from dotnet/dotnet-api-docs#5020
- Please respond to @gewarren.
From @gewarren on Wednesday, October 21, 2020 3:11:45 AM
Issue moved from MicrosoftDocs/feedback#3158
- Please respond to @welcome[bot].
From @welcome[bot] on Saturday, October 3, 2020 3:38:07 AM
Thank you for creating the issue! One of our team members will get back to you shortly with additional information. If this is a product issue, please close this and contact the particular product's support instead (see https://support.microsoft.com/allproducts for the list of support websites).
Issue moved from dotnet/dotnet-api-docs#5020
- Please respond to @gewarren.
From @gewarren on Saturday, February 5, 2022 2:59:47 AM
There are no docs because it's an internal class.
https://referencesource.microsoft.com/#System.Web/UrlMappingsModule.cs
Issue moved from dotnet/dotnet-api-docs#5020
- Please respond to @rossmpersonal.
From @rossmpersonal on Saturday, February 5, 2022 3:52:57 AM
Then where is documentation for the functionality, configuration, and/or use of the UrlMappingsModule ? I can find references to the existence of the UrlMappingsModule at:
https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/iis-modules-overview#module-reference https://docs.microsoft.com/en-us/powershell/module/webadministration/set-webmanagedmodule?view=windowsserver2022-ps#examples https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/modules?view=aspnetcore-6.0#managed-modules https://docs.microsoft.com/en-us/iis/web-hosting/migrate-to-the-microsoft-web-platform/iis-for-apache-administrators#using-modules-to-control-and-customize-iis https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537834(v=office.14)#the-request-pipeline https://download.microsoft.com/download/3/3/F/33F52373-3A75-422C-969B-61E05EEC5E72/SC2012_OpsMgr_Authoring.docx https://download.microsoft.com/download/3/3/F/33F52373-3A75-422C-969B-61E05EEC5E72/SC2012_OpsMgr_Authoring.pdf
but no documentation for the use of it.
Thank you.
On Fri, Feb 4, 2022, at 9:59 PM, Genevieve Warren wrote:
There are no docs because it's an internal class.
https://referencesource.microsoft.com/#System.Web/UrlMappingsModule.cs
— Reply to this email directly, view it on GitHub https://github.com/dotnet/dotnet-api-docs/issues/5020#issuecomment-1030508036, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANZC2IPLNZSKZ4PXMVBN7ETUZSHC5ANCNFSM4SZFNIQQ. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you were mentioned.Message ID: @.***>
Issue moved from dotnet/dotnet-api-docs#5020
- Please respond to @gewarren.
From @gewarren on Saturday, February 5, 2022 4:02:31 AM
In ASP.NET Core, it looks like this module is replace by URL Rewriting Middleware - https://docs.microsoft.com/en-us/aspnet/core/fundamentals/url-rewriting?view=aspnetcore-6.0.
But I'll reopen this issue and transfer it to the IIS docs repo in case some conceptual or hand-written reference docs can be added.
The only documentation is at https://referencesource.microsoft.com/#system.web/UrlMappingsModule.cs,da2b59836379bf01,references
https://referencesource.microsoft.com/#system.web/UrlMappingsModule.cs,da2b59836379bf01,references has no documentation. https://referencesource.microsoft.com/#system.web/UrlMappingsModule.cs,da2b59836379bf01,references provides absolutely no documentation about to how to configure or use the UrlMappingsModule . Hence, the reason for this issue.
@rossmpersonal A developer with basic IIS/ASP.NET background should be able to learn how to use it by merely reading the source code and comments.
The comment describes briefly that this managed module is in IIS default modules once you enable ASP.NET.
// Module that implements the UrlMappings functionality
// on IIS 7 in integrated mode, this takes the place of
// the UrlMappings execution step and is listed in <modules/>
The method UrlMappingRewritePath defined in https://referencesource.microsoft.com/#system.web/UrlMappingsModule.cs,33 first reads the configuration sections to learn what are the mapped URLs, and then perform rewrite logic accordingly.
Based on source code around UrlMappingsSection, the configuration fragment should look like below,
<system.web>
<urlMappings enabled="true">
<add url="someURL" mappedUrl="Another URL" />
</urlMappings>
</system.web>
Many old web pages contain discussions on this feature, such as this and this.
Clearly you don't need to use this feature any more as IIS URL Rewrite module is far better an alternative with more features and more documentation.
Therefore the documentation should be clarified to say that it is documented at https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms228302(v=vs.100)