Get D365LcsDatabaseBackups - FH-Inway/d365fo.tools GitHub Wiki
Get database backups from LCS project
Get-D365LcsDatabaseBackups [[-ProjectId] <Int32>] [[-BearerToken] <String>] [[-LcsApiUri] <String>] [-Latest]
[[-RetryTimeout] <TimeSpan>] [-EnableException] [<CommonParameters>]
Get the available database backups from the Asset Library in LCS project
Get-D365LcsDatabaseBackups -ProjectId 123456789 -BearerToken "JldjfafLJdfjlfsalfd..." -LcsApiUri "https://lcsapi.lcs.dynamics.com"
This will get all available database backups from the Asset Library inside LCS. The LCS project is identified by the ProjectId 123456789, which can be obtained in the LCS portal. The request will authenticate with the BearerToken "Bearer JldjfafLJdfjlfsalfd...". The http request will be going to the LcsApiUri "https://lcsapi.lcs.dynamics.com" (NON-EUROPE).
Get-D365LcsDatabaseBackups
This will get all available database backups from the Asset Library inside LCS. It will use default values for all parameters.
All default values will come from the configuration available from Get-D365LcsApiConfig.
The default values can be configured using Set-D365LcsApiConfig.
Get-D365LcsDatabaseBackups -Latest
This will get the latest available database backup from the Asset Library inside LCS. It will use default values for all parameters.
All default values will come from the configuration available from Get-D365LcsApiConfig.
The default values can be configured using Set-D365LcsApiConfig.
Get-D365LcsDatabaseBackups -Latest -RetryTimeout "00:01:00"
This will get the latest available database backup from the Asset Library inside LCS, and allow for the cmdlet to retry for no more than 1 minute. It will use default values for all parameters.
All default values will come from the configuration available from Get-D365LcsApiConfig.
The default values can be configured using Set-D365LcsApiConfig.
The project id for the Dynamics 365 for Finance & Operations project inside LCS
Default value can be configured using Set-D365LcsApiConfig
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: $Script:LcsApiProjectId
Accept pipeline input: False
Accept wildcard characters: False
The token you want to use when working against the LCS api
Default value can be configured using Set-D365LcsApiConfig
Type: String
Parameter Sets: (All)
Aliases: Token
Required: False
Position: 2
Default value: $Script:LcsApiBearerToken
Accept pipeline input: False
Accept wildcard characters: False
URI / URL to the LCS API you want to use
The value depends on where your LCS project is located. There are multiple 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.no.lcs.dynamics.com" "https://lcsapi.lcs.dynamics.cn" "https://lcsapi.gov.lcs.microsoftdynamics.us"
Default value can be configured using Set-D365LcsApiConfig
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: $Script:LcsApiLcsApiUri
Accept pipeline input: False
Accept wildcard characters: False
Instruct the cmdlet to only fetch the latest file from the Azure Storage Account
Type: SwitchParameter
Parameter Sets: (All)
Aliases: GetLatest
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 00:00:00
Accept pipeline input: False
Accept wildcard characters: False
This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Mötz Jensen (@Splaxi)