Tenant.GetSitePropertiesByUrl method

Returns properties for the site with the specified URL.

Namespace:  Microsoft.Online.SharePoint.TenantAdministration
Assembly:  Microsoft.Online.SharePoint.Client.Tenant (in Microsoft.Online.SharePoint.Client.Tenant.dll)

Syntax

'Declaration
Public Overridable Function GetSitePropertiesByUrl ( _
    url As String, _
    includeDetail As Boolean _
) As SiteProperties
'Usage
Dim instance As Tenant
Dim url As String
Dim includeDetail As Boolean
Dim returnValue As SiteProperties

returnValue = instance.GetSitePropertiesByUrl(url, _
    includeDetail)

public virtual SiteProperties GetSitePropertiesByUrl(
    string url,
    bool includeDetail
)

Parameters

• url
  Type: System.String

  A string that represents the site URL.

• includeDetail
  Type: System.Boolean

  A Boolean value that indicates whether to include all of the SPSite properties.

Return value

Type: Microsoft.Online.SharePoint.TenantAdministration.SiteProperties
SiteProperties

Remarks

This method throws an exception if the current user does not have access to the site.

See also

Reference

Tenant class

Tenant members

Microsoft.Online.SharePoint.TenantAdministration namespace