RetrieveAuditPartitionListRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to retrieve the list of database partitions that are used to store audited history data.
For the Web API use the RetrieveAuditPartitionList Function.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveAuditPartitionListRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveAuditPartitionListRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveAuditPartitionListRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RetrieveAuditPartitionListRequest() | Initializes a new instance of the RetrieveAuditPartitionListRequest class. |
Properties
Name | Description | |
---|---|---|
ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) |
|
Item[String] | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) |
|
Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
|
RequestId | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) |
|
RequestName | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 message 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 365 database servers that support partitioning. The partition list is sorted in date order and then returned.
Examples
// 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
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.
See Also
Microsoft.Crm.Sdk.Messages Namespace
Retrieve and delete the history of audited data changes
Sample: Audit entity data changes
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright