🔍 Code Extractor

class TenantCdnUrl

Maturity: 24

A client value class representing a SharePoint Tenant CDN URL entity, providing type identification for Microsoft SharePoint Tenant CDN URL objects.

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

Purpose

This class serves as a data model for SharePoint Tenant CDN URLs within the Office365 SDK. It inherits from ClientValue to provide serialization and deserialization capabilities for SharePoint API interactions. The class is primarily used to represent and handle CDN URL configurations at the tenant level in SharePoint Online environments.

Source Code

class TenantCdnUrl(ClientValue):
    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.TenantCdn.TenantCdnUrl"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: Inherits constructor from ClientValue base class. The base class typically accepts keyword arguments that map to the entity's properties, allowing initialization of CDN URL attributes through the parent class constructor.

Return Value

Instantiation returns a TenantCdnUrl object that represents a SharePoint Tenant CDN URL entity. The entity_type_name property returns the string 'Microsoft.SharePoint.TenantCdn.TenantCdnUrl', which identifies the entity type in SharePoint API communications.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the SharePoint entity type identifier for Tenant CDN URL objects

Returns: A string containing 'Microsoft.SharePoint.TenantCdn.TenantCdnUrl', which is the entity type name used by SharePoint API for identifying this entity type

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier 'Microsoft.SharePoint.TenantCdn.TenantCdnUrl' instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.cdn.tenant_cdn_url import TenantCdnUrl

Usage Example

from office365.sharepoint.tenant.cdn.tenant_cdn_url import TenantCdnUrl
from office365.runtime.client_value import ClientValue

# Instantiate a TenantCdnUrl object
cdn_url = TenantCdnUrl()

# Access the entity type name
entity_type = cdn_url.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.TenantCdn.TenantCdnUrl

# Typically used in context of SharePoint API operations
# The object would be populated with CDN URL data from SharePoint responses
# or used to send CDN URL configuration to SharePoint

Best Practices

  • This class is typically instantiated by the Office365 SDK internally when deserializing SharePoint API responses, rather than being manually created by developers.
  • The entity_type_name property is used by the SDK for proper serialization/deserialization with SharePoint REST API.
  • When working with Tenant CDN URLs, use this class in conjunction with SharePoint Tenant administration APIs.
  • Do not override the entity_type_name property as it must match the exact SharePoint entity type identifier.
  • Ensure proper authentication and tenant admin permissions before attempting to work with Tenant CDN configurations.
  • This class inherits all functionality from ClientValue, including property setting and getting mechanisms.

Tags

sharepoint cdn tenant url office365 client-value data-model entity microsoft

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class TenantCdnApi 79.2% similar

    TenantCdnApi is a SharePoint entity class that provides access to the Tenant CDN (Content Delivery Network) API for managing CDN settings at the tenant level.

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

  • class Office365Tenant 71.7% similar

    Represents a SharePoint Online tenant and provides administrative operations for managing tenant-level settings, CDN configurations, external users, themes, and user profile properties.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/management/office365_tenant.py

  • class SPOTenantWebTemplate 71.1% similar

    A client value class representing a SharePoint Online tenant web template in the Microsoft Online SharePoint Tenant Administration API.

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

  • class SiteCreationSource 64.5% similar

    A client value class representing a source for SharePoint site creation, containing a collection of site creation data objects.

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

  • class CollaborativeUsers 63.6% 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
← Back to Browse