PowerDataOps

2.0.0.4

src/Audit/Get-XrmAuditPartitions.ps1

<#
    .SYNOPSIS
    Retrieve audit partitions
    
    .DESCRIPTION
    Get record audit logs with date range and size.

    .PARAMETER XrmClient
    Xrm connector initialized to target instance. Use latest one by default. (Dataverse ServiceClient)
#>
function Get-XrmAuditPartitions {
    [CmdletBinding()]
    param
    (        
        [Parameter(Mandatory = $false, ValueFromPipeline)]
        [Microsoft.PowerPlatform.Dataverse.Client.ServiceClient]
        $XrmClient = $Global:XrmClient
    )
    begin {   
        $StopWatch = [System.Diagnostics.Stopwatch]::StartNew(); 
        Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Start -Parameters ($MyInvocation.MyCommand.Parameters); 
    }    
    process {
        $request = New-XrmRequest -Name "RetrieveAuditPartitionList";
        $response = $XrmClient | Invoke-XrmRequest -Request $request;

        $AuditPartitionDetailCollection = $response.Results["AuditPartitionDetailCollection"];
        $AuditPartitionDetailCollection | Select-Object PartitionNumber, StartDate, EndDate, Size;
    }
    end {
        $StopWatch.Stop();
        Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Stop -StopWatch $StopWatch;
    }    
}

Export-ModuleMember -Function Get-XrmAuditPartitions  -Alias *;