Managed Web Hosting::GetCustomerWebSiteProperties

  • Article

The GetCustomerWebSiteProperties method queries for details about a specified customer Web site.

Arguments

Input argument Required Description

<org>

Yes

The Lightweight Directory Access Protocol (LDAP) path of the owning organization.

<webSiteName> or <location>

Yes

For this parameter, use the unique Web site name that was established when creating the site, or you can use the IIS metabase path.

<preferredDomainController>

Yes

The name of the preferred domain controller.

<filter>

No

The "filter" attribute specifies what kinds of properties should be returned when all properties are requested. The filter element applies to the properties of the Web root. The "filter" value is a bit-field of the following values:

  • EXPLICIT = 1

  • INHERITED = 2

  • DEFAULT = 4

<properties>

No

A collection of the customer's root Web properties. Any valid property setting supported by the IIS provider can be passed through. Typical properties include:

  • AuthFlags - An optional integer. See the IIS documentation for legal values.

  • AppFriendlyName - An optional string. Defaults to "Default Application".

  • AppIsolated - An optional integer. Uses the IIS default.

  • AppPoolId - An optional string. IIS 6.0 only.

  • Path - An optional parameter that sets the local path of the Web site root.

  • AuthFlags - Optional authorization flags for the IIS server.

  • DefaultLogonDomain - An optional parameter that sets the default login domain.

<keys>

No

The "keys" node specifies any child keys for which properties should be fetched.

The <keys/> node may be omitted, or it may be empty. If an empty node is passed, then all descendent keys are returned. The keys node applies to any IIS paths beneath the root Web of the specified site, such as a virtual directory like IIS://WEB01/w3svc/10/Root/images. See the IIS Provider::GetProperties documentation for more information on this node.

Output Argument

The GetCustomerWebSiteProperties method returns the requested properties.

Remarks

Process Steps

The following steps occur when retrieving Web site properties with the GetCustomerWebSiteProperties method of the Managed Web Hosting Namespace:

  1. Requested Web site is owned by the organization.

  2. Retrieve properties.

Security

The GetCustomerWebSiteProperties method has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions by checking for membership in any of the following groups:

    • Domain Admins

    • Hosting Admins

    • Reseller Admins

Sample Code

Example XML Request

The following is an example of an XML request for the GetCustomerWebSiteProperties method of the Managed Web Hosting Namespace:

<request> 
        <procedure> 
                <execute namespace="Managed Web Hosting"  
                procedure="GetCustomerWebSiteProperties" impersonate="1"> 
                        <executeData> 
                        <preferredDomainController>AD01.fabrikam.com 
                        </preferredDomainController> 
                        <org>LDAP://OU=alpineskihouse,OU=consolidatedmessenger, 
                        OU=Hosting,DC=fabrikam,DC=Com</org> 
                        <webSiteName>www.alpineskihouse.com</webSiteName> 
                        <filter>1</filter> 
                        <properties> 
                                <property name="AppPoolId" /> 
                                <property name="AnonymousUserName" /> 
                        </properties> 
                        <keys></keys> 
                        </executeData> 
                        <after source="executeData" destination="data" mode="merge" /> 
                </execute> 
        </procedure> 
</request>

Example XML Response

The following is an example of an XML response from the GetCustomerWebSiteProperties method of the Managed Web Hosting Namespace:

<response> 
        <data> 
                <preferredDomainController>AD01-wh.fabrikam.com 
                </preferredDomainController> 
                <org>LDAP://OU=alpineskihouse,OU=consolidatedmessenger, 
                 OU=Hosting,DC=fabrikam,DC=Com</org> 
                <webSiteName>www.alpineskihouse2.com</webSiteName> 
                <filter>1</filter> 
                <properties> 
                        <property name="AppPoolId" /> 
                        <property name="AnonymousUserName" /> 
                </properties> 
                <website name="www.alpineskihouse2.com" webRootShare="\\app01- 
                 ra\websites$\alpineskihouse\www.alpineskihouse2.com" 
                 location="IIS://app01-ra/W3SVC/15192358"> 
                <key path="IIS://app01-ra/W3SVC/15192358" name="15192358"  
                 type="IIsWebServer"> 
                        <properties> 
                        <property name="ServerComment" attr="1"  
                         type="sz">www.alpineskihouse2.com</property> 
                        <property name="ServerBindings" attr="0" type="multiSz"> 
                                <values> 
                                        <value>:80:www.alpineskihouse2.com</value> 
                                        <value>:80:support.alpineskihouse.com</value> 
                                        <value>:80:help.alpineskihouse.com</value> 
                                </values> 
                        </property> 
                        <property name="ServerAutoStart" attr="0"  
                         type="bool">1</property> 
                        <property name="ServerState" attr="16" type="long">2</property> 
                        </properties> 
                                <keys> 
                                        <key path="IIS://app01-ra/W3SVC/15192358/Root" name="Root"  
                                         type="IIsWebVirtualDir"> 
                                        <properties> 
                                        <property name="AppPoolId" attr="1"  
                                         type="sz">AnotherPool</property> 
                                        <property name="AnonymousUserName" attr="1"  
                                         type="sz">fabrikam\W3SVC15192358_Anon_A</property> 
                                        </properties> 
                                        </key> 
                                </keys> 
        </key> 
                </website> 
        </data> 
</response>

Applies To

Managed Web Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Managed Web Hosting::QueryWebSitesByCustomer