RetrieveAuditPartitionListRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve the list of database partitions that are used to store audited history data.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveAuditPartitionListRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveAuditPartitionListRequest : OrganizationRequest

Example

// Get the list of audit partitions.
RetrieveAuditPartitionListResponse partitionRequest =
    (RetrieveAuditPartitionListResponse)_service.Execute(new RetrieveAuditPartitionListRequest());
AuditPartitionDetailCollection partitions = partitionRequest.AuditPartitionDetailCollection;

' Get the list of audit partitions.
Dim partitionRequest As RetrieveAuditPartitionListResponse = CType(_service.Execute(New RetrieveAuditPartitionListRequest()), RetrieveAuditPartitionListResponse)
Dim partitions As AuditPartitionDetailCollection = partitionRequest.AuditPartitionDetailCollection

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveAuditPartitionListResponse class.

Privileges and Access Rights

For a list of the required privileges, see RetrieveAuditPartitionList Privileges.

Notes for Callers

New partitions are automatically created by the Microsoft Dynamics CRM platform on a quarterly basis each year. Audit partitions exist only on Microsoft Dynamics CRM database servers that support partitioning. The partition list is sorted in date order and then returned.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RetrieveAuditPartitionListRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

RetrieveAuditPartitionListRequest Members
Microsoft.Crm.Sdk.Messages Namespace

Other Resources

Retrieve and Delete the History of Audited Data Changes
Sample: Audit Entity Data Changes

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.