introduced admin namespace with new types

Author: vgrem

examples/sharepoint/taxonomy/get_term_by_id.py

@@ -0,0 +1,16 @@
+"""
+Gets Term by id
+"""
+
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_team_site_url
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+term_guid = "f9a6dae9-633c-474b-b35e-b235cf2b9e73"
+taxonomy_list = ctx.web.lists.get_by_title("TaxonomyHiddenList")
+result = (
+    taxonomy_list.items.first("IdForTerm eq '{0}'".format(term_guid))
+    .get()
+    .execute_query()
+)
+print(result.properties.get("Title"))

generator/import_metadata.py

@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="sharepoint",
+    default="graph",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/SharePoint.xml",
+    default="./metadata/Graph.xml",
     help="Import metadata endpoint",
 )
 

generator/metadata/Graph.xml

@@ -39197,6 +39197,11 @@ within the time frame of their original request."/>
             <Parameter Name="value" Type="Collection(graph.site)"/>
             <ReturnType Type="Collection(graph.site)"/>
          </Action>
+         <Action Name="remove" IsBound="true">
+            <Parameter Name="bindingParameter" Type="Collection(graph.conversationMember)"/>
+            <Parameter Name="values" Type="Collection(graph.conversationMember)"/>
+            <ReturnType Type="Collection(graph.actionResultPart)"/>
+         </Action>
          <Function Name="getAllSites" IsBound="true">
             <Parameter Name="bindingParameter" Type="Collection(graph.site)"/>
             <ReturnType Type="Collection(graph.site)"/>

office365/admin/__init__.py

@@ -0,0 +1,69 @@
+from office365.admin.microsoft365_apps import AdminMicrosoft365Apps
+from office365.admin.people_settings import PeopleAdminSettings
+from office365.admin.report_settings import AdminReportSettings
+from office365.admin.sharepoint import Sharepoint
+from office365.entity import Entity
+from office365.intune.servicecommunications.announcement import ServiceAnnouncement
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class Admin(Entity):
+    """Entity that acts as a container for administrator functionality."""
+
+    @property
+    def microsoft365_apps(self):
+        """A container for the Microsoft 365 apps admin functionality."""
+        return self.properties.get(
+            "microsoft365Apps",
+            AdminMicrosoft365Apps(
+                self.context, ResourcePath("microsoft365Apps", self.resource_path)
+            ),
+        )
+
+    @property
+    def sharepoint(self):
+        """A container for administrative resources to manage tenant-level settings for SharePoint and OneDrive."""
+        return self.properties.get(
+            "sharepoint",
+            Sharepoint(self.context, ResourcePath("sharepoint", self.resource_path)),
+        )
+
+    @property
+    def service_announcement(self):
+        """A container for service communications resources. Read-only."""
+        return self.properties.get(
+            "serviceAnnouncement",
+            ServiceAnnouncement(
+                self.context, ResourcePath("serviceAnnouncement", self.resource_path)
+            ),
+        )
+
+    @property
+    def report_settings(self):
+        """A container for administrative resources to manage reports."""
+        return self.properties.get(
+            "reportSettings",
+            AdminReportSettings(
+                self.context, ResourcePath("reportSettings", self.resource_path)
+            ),
+        )
+
+    @property
+    def people(self):
+        """Represents a setting to control people-related admin settings in the tenant."""
+        return self.properties.get(
+            "people",
+            PeopleAdminSettings(
+                self.context, ResourcePath("people", self.resource_path)
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "microsoft365Apps": self.microsoft365_apps,
+                "serviceAnnouncement": self.service_announcement,
+                "reportSettings": self.report_settings,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Admin, self).get_property(name, default_value)

office365/admin/admin.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class AdminMicrosoft365Apps(Entity):
+    """Represents an entity that acts as a container for administrator functionality for Microsoft 365 applications."""

office365/admin/microsoft365_apps.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class PeopleAdminSettings(Entity):
+    """Represents a setting to control people-related admin settings in the tenant."""

office365/admin/people_settings.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class AdminReportSettings(Entity):
+    """Represents the tenant-level settings for Microsoft 365 reports."""

office365/admin/report_settings.py

@@ -1,5 +1,5 @@
+from office365.admin.sharepoint_settings import SharepointSettings
 from office365.entity import Entity
-from office365.onedrive.sharepoint_settings import SharepointSettings
 from office365.runtime.paths.resource_path import ResourcePath
 
 

office365/onedrive/sharepoint.py renamed to office365/admin/sharepoint.py

@@ -0,0 +1,7 @@
+from office365.directory.identitygovernance.privilegedaccess.schedule_instance import (
+    PrivilegedAccessScheduleInstance,
+)
+
+
+class PrivilegedAccessGroupAssignmentScheduleInstance(PrivilegedAccessScheduleInstance):
+    """Represents an instance of a provisioned membership or ownership assignment in PIM for groups."""

office365/onedrive/sharepoint_settings.py renamed to office365/admin/sharepoint_settings.py

@@ -3,8 +3,12 @@
 
 
 class ResourceAction(ClientValue):
-    """ """
+    """Set of allowed and not allowed actions for a resource."""
 
-    def __init__(self):
-        self.allowedResourceActions = StringCollection()
-        self.notAllowedResourceActions = StringCollection()
+    def __init__(self, allowed=None, not_allowed=None):
+        """
+        :param list[str] allowed: Allowed Actions
+        :param list[str] not_allowed: Not Allowed Actions.
+        """
+        self.allowedResourceActions = StringCollection(allowed)
+        self.notAllowedResourceActions = StringCollection(not_allowed)

office365/directory/identitygovernance/privilegedaccess/group_assignment_schedule_instance.py

@@ -4,7 +4,7 @@
 
 
 class RolePermission(ClientValue):
-    """ """
+    """Contains the set of ResourceActions determining the allowed and not allowed permissions for each role."""
 
-    def __init__(self, resourceActions=None):
-        self.resourceActions = ClientValueCollection(ResourceAction, resourceActions)
+    def __init__(self, resource_actions=None):
+        self.resourceActions = ClientValueCollection(ResourceAction, resource_actions)

office365/directory/rolemanagement/resource_action.py

@@ -0,0 +1,49 @@
+from office365.directory.security.alerts.alert import Alert
+from office365.entity_collection import EntityCollection
+from office365.runtime.http.request_options import RequestOptions
+
+
+class AlertCollection(EntityCollection[Alert]):
+    """Service Principal's collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(AlertCollection, self).__init__(context, Alert, resource_path)
+
+    def add(
+        self,
+        title,
+        description=None,
+        severity=None,
+        category=None,
+        status=None,
+        source=None,
+        vendor_information=None,
+    ):
+        """
+        Creates an alert object.
+        :param str title:
+        :param str description:
+        :param str severity:
+        :param str category:
+        :param str status:
+        :param str source:
+        :param str vendor_information:
+        """
+
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            request.set_header("Content-Type", "application/json")
+
+        return (
+            super(AlertCollection, self)
+            .add(
+                title=title,
+                description=description,
+                severity=severity,
+                category=category,
+                status=status,
+                source=source,
+                vendorInformation=vendor_information,
+            )
+            .before_execute(_construct_request)
+        )

office365/directory/rolemanagement/role_permission.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class SecureScoreControlProfile(Entity):
+    """Represents a tenant's secure score per control data. By default, it returns all controls
+    for a tenant and can explicitly pull individual controls."""

office365/directory/security/alerts/collection.py

@@ -1,8 +1,10 @@
 from office365.directory.security.alerts.alert import Alert
+from office365.directory.security.alerts.collection import AlertCollection
 from office365.directory.security.attacksimulations.root import AttackSimulationRoot
 from office365.directory.security.cases.root import CasesRoot
 from office365.directory.security.hunting_query_results import HuntingQueryResults
 from office365.directory.security.incidents.incident import Incident
+from office365.directory.security.scorecontrol.profile import SecureScoreControlProfile
 from office365.directory.security.threatintelligence.threat_intelligence import (
     ThreatIntelligence,
 )
@@ -35,12 +37,10 @@ def run_hunting_query(self, query):
 
     @property
     def alerts(self):
-        # type: () -> EntityCollection[Alert]
+        # type: () -> AlertCollection
         return self.properties.get(
             "alerts",
-            EntityCollection(
-                self.context, Alert, ResourcePath("alerts", self.resource_path)
-            ),
+            AlertCollection(self.context, ResourcePath("alerts", self.resource_path)),
         )
 
     @property
@@ -83,6 +83,18 @@ def incidents(self):
             ),
         )
 
+    @property
+    def secure_score_control_profiles(self):
+        """"""
+        return self.properties.get(
+            "secureScoreControlProfiles",
+            EntityCollection(
+                self.context,
+                SecureScoreControlProfile,
+                ResourcePath("secureScoreControlProfiles", self.resource_path),
+            ),
+        )
+
     @property
     def triggers(self):
         """"""
@@ -106,6 +118,7 @@ def get_property(self, name, default_value=None):
             property_mapping = {
                 "alerts_v2": self.alerts_v2,
                 "attackSimulation": self.attack_simulation,
+                "secureScoreControlProfiles": self.secure_score_control_profiles,
                 "threatIntelligence": self.threat_intelligence,
             }
             default_value = property_mapping.get(name, None)

office365/directory/security/scorecontrol/__init__.py

@@ -0,0 +1,11 @@
+from office365.entity import Entity
+
+
+class MultiTenantOrganization(Entity):
+    """
+    Defines an organization with more than one instance of Microsoft Entra ID. A multitenant organization enables
+    multiple tenants to collaborate like a single entity.
+
+    There can only be one multitenant organization per active tenant. It is not possible to be part of multiple
+    multitenant organizations.
+    """

office365/directory/security/scorecontrol/profile.py

@@ -0,0 +1,61 @@
+from office365.directory.tenantinformation.information import TenantInformation
+from office365.directory.tenantinformation.multi_organization import (
+    MultiTenantOrganization,
+)
+from office365.entity import Entity
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
+
+
+class TenantRelationship(Entity):
+    """Represent the various type of tenant relationships."""
+
+    def find_tenant_information_by_domain_name(self, domain_name):
+        """Given a domain name, search for a tenant and read its tenantInformation. You can use this API to
+        validate tenant information and use their tenantId to configure cross-tenant access settings between you
+        and the tenant.
+
+        :param str domain_name: Primary domain name of an Azure AD tenant.
+        """
+        return_type = ClientResult(self.context, TenantInformation())
+        params = {"domainName": domain_name}
+        qry = FunctionQuery(
+            self, "findTenantInformationByDomainName", params, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    def find_tenant_information_by_tenant_id(self, tenant_id):
+        """Given a tenant ID, search for a tenant and read its tenantInformation. You can use this API to validate
+        tenant information and use the tenantId to configure cross-tenant cross-tenant access settings between you
+        and the tenant.
+
+        :param str tenant_id: Unique tenant identifier of a Microsoft Entra tenant.
+        """
+        return_type = ClientResult(self.context, TenantInformation())
+        params = {"tenantId": tenant_id}
+        qry = FunctionQuery(
+            self, "findTenantInformationByTenantId", params, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def multi_tenant_organization(self):
+        """Represents a setting to control people-related admin settings in the tenant."""
+        return self.properties.get(
+            "multiTenantOrganization",
+            MultiTenantOrganization(
+                self.context,
+                ResourcePath("multiTenantOrganization", self.resource_path),
+            ),
+        )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "multiTenantOrganization": self.multi_tenant_organization,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(TenantRelationship, self).get_property(name, default_value)