internal/functions/get-lcsenvironmentmetadata.ps1


<#
    .SYNOPSIS
        Get LCS environment meta data from within a project
         
    .DESCRIPTION
        Get all meta data details for environments from within a LCS project
         
        It supports listing all environments, but also supports single / specific environments by searching based on EnvironmentId or EnvironmentName
         
         
    .PARAMETER ProjectId
        The project id for the Dynamics 365 for Finance & Operations project inside LCS
         
    .PARAMETER BearerToken
        The token you want to use when working against the LCS api
         
    .PARAMETER EnvironmentId
        The unique id of the environment that you want to work against
         
        The Id can be located inside the LCS portal
         
        Either you want to utilize the EnvironmentId parameter or you can utilize the EnvironmentName parameter, only one of them is valid in a request
         
    .PARAMETER EnvironmentName
        The unique name of the environment that you want to work against
         
        The Id can be located inside the LCS portal
         
        Either you want to utilize the EnvironmentName parameter or you can utilize the EnvironmentId parameter, only one of them is valid in a request
         
         
    .PARAMETER Page
        Page number that you want to request from the LCS API
         
        This is part of the initial request, which helps you navigate more data - when it is available
         
    .PARAMETER LcsApiUri
        URI / URL to the LCS API you want to use
         
        Depending on whether your LCS project is located in europe or not, there is 2 valid URI's / URL's
         
        Valid options:
        "https://lcsapi.lcs.dynamics.com"
        "https://lcsapi.eu.lcs.dynamics.com"
        "https://lcsapi.fr.lcs.dynamics.com"
        "https://lcsapi.sa.lcs.dynamics.com"
        "https://lcsapi.uae.lcs.dynamics.com"
        "https://lcsapi.ch.lcs.dynamics.com"
        "https://lcsapi.lcs.dynamics.cn"
        "https://lcsapi.gov.lcs.microsoftdynamics.us"
         
    .PARAMETER RetryTimeout
        The retry timeout, before the cmdlet should quit retrying based on the 429 status code
         
        Needs to be provided in the timspan notation:
        "hh:mm:ss"
         
        hh is the number of hours, numerical notation only
        mm is the number of minutes
        ss is the numbers of seconds
         
        Each section of the timeout has to valid, e.g.
        hh can maximum be 23
        mm can maximum be 59
        ss can maximum be 59
         
        Not setting this parameter will result in the cmdlet to try for ever to handle the 429 push back from the endpoint
         
    .PARAMETER EnableException
        This parameters disables user-friendly warnings and enables the throwing of exceptions
        This is less user friendly, but allows catching exceptions in calling scripts
         
    .EXAMPLE
        PS C:\> Get-LcsEnvironmentMetadata -ProjectId 123456789 -Token "Bearer JldjfafLJdfjlfsalfd..." -LcsApiUri "https://lcsapi.lcs.dynamics.com"
         
        This will list the first page of environment metadata from the LCS API, across all available environments.
        The ProjectId "123456789" is the desired project.
        The Token "Bearer JldjfafLJdfjlfsalfd..." is the authentication to be used.
        The http request will be going to the LcsApiUri "https://lcsapi.lcs.dynamics.com" (NON-EUROPE).
         
    .EXAMPLE
        PS C:\> Get-LcsEnvironmentMetadata -ProjectId 123456789 -Token "Bearer JldjfafLJdfjlfsalfd..." -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" -LcsApiUri "https://lcsapi.lcs.dynamics.com"
         
        This will list the first page of environment metadata from the LCS API.
        The ProjectId "123456789" is the desired project.
        The Token "Bearer JldjfafLJdfjlfsalfd..." is the authentication to be used.
        The EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" is the specific environment that we want metadata from.
        The http request will be going to the LcsApiUri "https://lcsapi.lcs.dynamics.com" (NON-EUROPE).
         
    .EXAMPLE
        PS C:\> Get-LcsEnvironmentMetadata -ProjectId 123456789 -Token "Bearer JldjfafLJdfjlfsalfd..." -EnvironmentName "Contoso-SIT" -LcsApiUri "https://lcsapi.lcs.dynamics.com"
         
        This will list the first page of environment metadata from the LCS API.
        The ProjectId "123456789" is the desired project.
        The Token "Bearer JldjfafLJdfjlfsalfd..." is the authentication to be used.
        The EnvironmentName "Contoso-SIT" is the specific environment that we want metadata from.
        The http request will be going to the LcsApiUri "https://lcsapi.lcs.dynamics.com" (NON-EUROPE).
         
    .NOTES
        Author: Mötz Jensen (@Splaxi)
#>

function Get-LcsEnvironmentMetadata {
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
    # [CmdletBinding()]
    [CmdletBinding(DefaultParameterSetName = 'Default')]
    param(
        [Parameter(Mandatory = $true)]
        [int] $ProjectId,
    
        [Alias('Token')]
        [string] $BearerToken,

        [Parameter(ParameterSetName = 'SearchByEnvironmentId')]
        [string] $EnvironmentId,

        [Parameter(ParameterSetName = 'SearchByEnvironmentName')]
        [string] $EnvironmentName,

        [Parameter(ParameterSetName = 'Pagination')]
        [int] $Page,
        
        [Parameter(Mandatory = $true)]
        [string] $LcsApiUri,

        [Timespan] $RetryTimeout = "00:00:00",

        [switch] $EnableException
    )

    begin {
        Invoke-TimeSignal -Start
        
        $headers = @{
            "Authorization" = "$BearerToken"
        }

        $parms = @{}
        $parms.Method = "GET"
        $parms.Uri = "$LcsApiUri/environmentinfo/v1/detail/project/$($ProjectId)"
        $parms.Headers = $headers
        $parms.RetryTimeout = $RetryTimeout

        if ($PSCmdlet.ParameterSetName -eq "Pagination") {
            $parms.Uri += "/?page=$Page"
        }
        elseif ($PSCmdlet.ParameterSetName -eq "SearchByEnvironmentId") {
            $parms.Uri += "/?environmentId=$EnvironmentId"
        }
        elseif ($PSCmdlet.ParameterSetName -eq "SearchByEnvironmentName") {
            $parms.Uri += "/?environmentName=$EnvironmentName"
        }
    }

    process {
        try {
            Write-PSFMessage -Level Verbose -Message "Invoke LCS request."
            Invoke-RequestHandler @parms
        }
        catch [System.Net.WebException] {
            Write-PSFMessage -Level Host -Message "Error status code <c='em'>$($_.exception.response.statuscode)</c> in request for getting the environment metadata a project in LCS. <c='em'>$($_.exception.response.StatusDescription)</c>." -Exception $PSItem.Exception
            Stop-PSFFunction -Message "Stopping because of errors" -StepsUpward 1
            return
        }
        catch {
            Write-PSFMessage -Level Host -Message "Something went wrong while working against the LCS API." -Exception $PSItem.Exception
            Stop-PSFFunction -Message "Stopping because of errors" -StepsUpward 1
            return
        }

        Invoke-TimeSignal -End
    }
}