Interface IMicrosoft365Admin
Microsoft 365 Admin features
Namespace: PnP.Core.Admin.Model.Microsoft365
Assembly: PnP.Core.Admin.dll
Syntax
public interface IMicrosoft365Admin
Methods
AccessTokenHasRole(String)
Checks if the current access token holds the requested role
Declaration
bool AccessTokenHasRole(string role)
Parameters
System.String
role
Role to check for |
Returns
System.Boolean
True if the token has the role, false otherwise |
AccessTokenHasRole(String, String)
Checks if the provided access token holds the requested role
Declaration
bool AccessTokenHasRole(string accessToken, string role)
Parameters
System.String
accessToken
Accesstoken to inspect |
System.String
role
Role to check for |
Returns
System.Boolean
True if the token has the role, false otherwise |
AccessTokenHasRoleAsync(String)
Checks if the current access token holds the requested role
Declaration
Task<bool> AccessTokenHasRoleAsync(string role)
Parameters
System.String
role
Role to check for |
Returns
Task<System.Boolean>
True if the token has the role, false otherwise |
AccessTokenHasScope(String)
Checks if the current access token holds the requested scope
Declaration
bool AccessTokenHasScope(string scope)
Parameters
System.String
scope
Scope to check for |
Returns
System.Boolean
True if the token has the scope, false otherwise |
AccessTokenHasScope(String, String)
Checks if the provided access token holds the requested scope
Declaration
bool AccessTokenHasScope(string accessToken, string scope)
Parameters
System.String
accessToken
Accesstoken to inspect |
System.String
scope
Scope to check for |
Returns
System.Boolean
True if the token has the scope, false otherwise |
AccessTokenHasScopeAsync(String)
Checks if the current access token holds the requested scope
Declaration
Task<bool> AccessTokenHasScopeAsync(string scope)
Parameters
System.String
scope
Scopee to check for |
Returns
Task<System.Boolean>
True if the token has the scope, false otherwise |
AccessTokenUsesApplicationPermissions()
Checks if the current access token uses application permissions
Declaration
bool AccessTokenUsesApplicationPermissions()
Returns
System.Boolean
True if using application permissions, false otherwise |
AccessTokenUsesApplicationPermissions(String)
Checks if the provided access token uses application permissions
Declaration
bool AccessTokenUsesApplicationPermissions(string accessToken)
Parameters
System.String
accessToken
Accesstoken to inspect |
Returns
System.Boolean
True if using application permissions, false otherwise |
AccessTokenUsesApplicationPermissionsAsync()
Checks if the current access token uses application permissions
Declaration
Task<bool> AccessTokenUsesApplicationPermissionsAsync()
Returns
Task<System.Boolean>
True if using application permissions, false otherwise |
CreateGroup(GraphGroupOptions, CreationOptions)
Create a Microsoft 365 Group
Declaration
PnPContext CreateGroup(GraphGroupOptions graphGroupOptions, CreationOptions creationOptions = null)
Parameters
GraphGroupOptions
graphGroupOptions
Options that define the Microsoft 365 Group to create |
CreationOptions
creationOptions
Options that control the group creation process |
Returns
PnPContext
PnPContext for the SharePoint site linked the new group |
CreateGroupAsync(GraphGroupOptions, CreationOptions)
Create a Microsoft 365 Group
Declaration
Task<PnPContext> CreateGroupAsync(GraphGroupOptions graphGroupOptions, CreationOptions creationOptions = null)
Parameters
GraphGroupOptions
graphGroupOptions
Options that define the Microsoft 365 Group to create |
CreationOptions
creationOptions
Options that control the group creation process |
Returns
Task<PnPContext>
PnPContext for the SharePoint site linked the new group |
GetMultiGeoLocations()
Returns a list of multi-geo locations for this tenant
Declaration
List<IGeoLocationInformation> GetMultiGeoLocations()
Returns
List<IGeoLocationInformation>
List of multi-geo locations if multi-geo, null otherwise |
GetMultiGeoLocationsAsync()
Returns a list of multi-geo locations for this tenant
Declaration
Task<List<IGeoLocationInformation>> GetMultiGeoLocationsAsync()
Returns
Task<List<IGeoLocationInformation>>
List of multi-geo locations if multi-geo, null otherwise |
GetSensitivityLabels()
Get the available sensitivity labels for the calling user or application
Declaration
List<ISensitivityLabel> GetSensitivityLabels()
Returns
List<ISensitivityLabel>
List of sensitivity labels |
GetSensitivityLabelsAsync()
Get the available sensitivity labels for the calling user or application
Declaration
Task<List<ISensitivityLabel>> GetSensitivityLabelsAsync()
Returns
Task<List<ISensitivityLabel>>
List of sensitivity labels |
GroupExists(String)
Check if a Microsoft 365 group exists
Declaration
bool GroupExists(string mailNickName)
Parameters
System.String
mailNickName
Microsoft 365 group alias to check for |
Returns
System.Boolean
True if the group exists, false otherwise |
GroupExistsAsync(String)
Check if a Microsoft 365 group exists
Declaration
Task<bool> GroupExistsAsync(string mailNickName)
Parameters
System.String
mailNickName
Microsoft 365 group alias to check for |
Returns
Task<System.Boolean>
True if the group exists, false otherwise |
IsMultiGeoTenant()
Checks if this tenant is a multi-geo tenant
Declaration
bool IsMultiGeoTenant()
Returns
System.Boolean
True if multi-geo, false otherwise |
IsMultiGeoTenantAsync()
Checks if this tenant is a multi-geo tenant
Declaration
Task<bool> IsMultiGeoTenantAsync()
Returns
Task<System.Boolean>
True if multi-geo, false otherwise |