Functions/Get-NotUsedSinceArtifacts.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<#PSScriptInfo
 
.VERSION 1.0.0
 
.GUID
 
.AUTHOR Artsiom Krot
 
.PROJECTURI https://github.com/artyom-krot/PS.JfrogArtifactory
 
.RELEASENOTES
 
 
Script file name:
 
    Get-NotUsedSinceArtifacts.ps1
 
.DESCRIPTION
 
    The script is an integral part of PS.JfrogArtifactory solution (https://github.com/artyom-krot/PS.JfrogArtifactory)
 
    Jfrog ref documentation: https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactsNotDownloadedSince
 
#>



function Get-NotUsedSinceArtifacts {
    <#
    .SYNOPSIS
        PowerShell script for invoking rest api call to jfrog artifactory to get the list of artifacts, that has not been used for amount of days.
 
    .DESCRIPTION
         
         
    .INPUTS
        -Repository <string[]>
 
        -NotUsedSinceInDays <int[]>
 
    .OUTPUTS
        Array of objects, containing information about the artifact (artifact uri, downloadCount, lastDownloaded date, remoteDownloadCount, remoteLastDownloaded date)
 
    .NOTES
         
     
    .EXAMPLE
        Get-NotUsedSinceArtifacts -Repository nuget-prod -NotUsedSinceInDays 90
 
    #>


    [CmdletBinding()]
    param(
        [parameter(Position = 0, Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $Repository,

        [parameter(Position = 1, Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [int]
        $NotUsedSinceInDays
    )

    # Convert required date to Unix Epoch format
    $notUsedSince = [int64]((([datetime]::UtcNow).AddDays(-$NotUsedSinceInDays))-(get-date "1/1/1970")).TotalMilliseconds

    $response = Invoke-ArtifactoryRestApi -RestApiPath "/api/search/usage?notUsedSince=$notUsedSince&repos=$Repository" `
                                          -ContentType 'application/json'
    
    return $response.results
}