🔍 Code Extractor

class UnifiedAuditRecord

Maturity: 24

A data class representing a Unified Audit Record in Microsoft SharePoint's Tenant Administration, inheriting from ClientValue to provide serialization capabilities.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/audit/unified_record.py
Lines:
4 - 7
Complexity:
simple

Purpose

This class serves as a data transfer object (DTO) for unified audit records in SharePoint Online tenant administration. It extends ClientValue to enable proper serialization/deserialization when communicating with SharePoint REST APIs. The class identifies itself with a specific entity type name used by the SharePoint Administration API for audit record operations.

Source Code

class UnifiedAuditRecord(ClientValue):
    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: Inherits constructor from ClientValue base class. The parent class typically accepts keyword arguments that map to properties of the audit record entity.

Return Value

Instantiation returns a UnifiedAuditRecord object that can be used to represent audit record data. The entity_type_name property returns a string identifying the SharePoint entity type: 'Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord'.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by SharePoint's Tenant Administration API to identify unified audit records

Returns: A string containing the entity type identifier: 'Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord'

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier for unified audit records instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.administration.tenant_admin.unified_audit_record import UnifiedAuditRecord

Usage Example

from office365.sharepoint.administration.tenant_admin.unified_audit_record import UnifiedAuditRecord

# Instantiate a unified audit record
audit_record = UnifiedAuditRecord()

# Access the entity type name (used internally by the API)
entity_type = audit_record.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord

# Typically used in context of SharePoint client operations
# Example: Creating or querying audit records through SharePoint API
# from office365.sharepoint.client_context import ClientContext
# ctx = ClientContext(site_url).with_credentials(credentials)
# audit_records = ctx.web.get_property('UnifiedAuditRecords')
# ctx.execute_query()

Best Practices

  • This class is primarily used internally by the Office365-REST-Python-Client library for type identification and serialization
  • Do not modify the entity_type_name property as it must match the exact SharePoint API entity type
  • Instantiate this class when working with SharePoint tenant administration audit operations
  • The class inherits from ClientValue which provides automatic serialization/deserialization for SharePoint API calls
  • Typically used in conjunction with SharePoint ClientContext for executing queries against tenant administration endpoints
  • This is a lightweight data class with minimal state - it's safe to create multiple instances

Tags

sharepoint audit tenant-administration data-transfer-object dto client-value office365 compliance logging

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class AuditData 84.1% similar

    AuditData is a data class representing audit data in Microsoft SharePoint Tenant Administration, inheriting from ClientValue to provide serialization capabilities.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/audit/data.py

  • class AuditSearchRequestStatus 65.7% similar

    A client value class representing the status of an audit search request in SharePoint Tenant Administration.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/audit/search_request_status.py

  • class CollaborationInsightsOverview 64.6% similar

    A data class representing collaboration insights overview information for SharePoint tenant administration, inheriting from ClientValue to provide serialization capabilities.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/collaboration/insights_overview.py

  • class CollaborativeUsers 62.7% similar

    A class representing collaborative users in Microsoft SharePoint Administration, inheriting from ClientValue to provide entity type identification for SharePoint tenant administration operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/collaboration/insights_data.py

  • class Audit 61.9% similar

    A class that enables auditing of how SharePoint site collections, sites, lists, folders, and list items are accessed, changed, and used.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/audit/audit.py
← Back to Browse