-
Notifications
You must be signed in to change notification settings - Fork 94
Get D365LcsDeploymentStatus
Get the Deployment status from LCS
Get-D365LcsDeploymentStatus [[-ProjectId] <Int32>] [[-BearerToken] <String>] [-ActivityId] <String>
[-EnvironmentId] <String> [[-LcsApiUri] <String>] [-WaitForCompletion] [[-SleepInSeconds] <Int32>]
[-FailOnErrorMessage] [[-RetryTimeout] <TimeSpan>] [-EnableException] [<CommonParameters>]
Get the Deployment status for activity against an environment from the Dynamics LCS Portal
Get-D365LcsDeploymentStatus -ProjectId 123456789 -ActivityId 123456789 -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" -BearerToken "Bearer JldjfafLJdfjlfsalfd..." -LcsApiUri "https://lcsapi.lcs.dynamics.com"
This will check the deployment status of specific activity against an environment. The LCS project is identified by the ProjectId 123456789, which can be obtained in the LCS portal. The activity is identified by the ActivityId 123456789, which is obtained from the Invoke-D365LcsDeployment execution. The environment is identified by the EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e", 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-D365LcsDeploymentStatus -ActivityId 123456789 -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e"
This will check the deployment status of specific activity against an environment. The activity is identified by the ActivityId 123456789, which is obtained from the Invoke-D365LcsDeployment execution. The environment is identified by the EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e", which can be obtained in the LCS portal.
All default values will come from the configuration available from Get-D365LcsApiConfig.
The default values can be configured using Set-D365LcsApiConfig.
Get-D365LcsDeploymentStatus -ActivityId 123456789 -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" -WaitForCompletion
This will check the deployment status of specific activity against an environment. The activity is identified by the ActivityId 123456789, which is obtained from the Invoke-D365LcsDeployment execution. The environment is identified by the EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e", which can be obtained in the LCS portal. The cmdlet will every 300 seconds contact the LCS API endpoint and check if the status of the deployment is either success or failure.
All default values will come from the configuration available from Get-D365LcsApiConfig.
The default values can be configured using Set-D365LcsApiConfig.
Get-D365LcsDeploymentStatus -ActivityId 123456789 -EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e" -RetryTimeout "00:01:00"
This will check the deployment status of specific activity against an environment, and allow for the cmdlet to retry for no more than 1 minute. The activity is identified by the ActivityId 123456789, which is obtained from the Invoke-D365LcsDeployment execution. The environment is identified by the EnvironmentId "13cc7700-c13b-4ea3-81cd-2d26fa72ec5e", which can be obtained in the LCS portal.
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: FalseThe 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: FalseThe unique id of the action that you started from the Invoke-D365LcsDeployment cmdlet
Type: String
Parameter Sets: (All)
Aliases: ActionHistoryId
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe unique id of the environment that you want to work against
The Id can be located inside the LCS portal
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURI / 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: 5
Default value: $Script:LcsApiLcsApiUri
Accept pipeline input: False
Accept wildcard characters: FalseInstruct the cmdlet to wait for the deployment process to complete
The cmdlet will sleep for 300 seconds, before requesting the status of the deployment process from LCS
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseTime in secounds that you want the cmdlet to use as the sleep timer between each request against the LCS endpoint
Default value is 300
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 300
Accept pipeline input: False
Accept wildcard characters: FalseInstruct the cmdlet to write logging information to the console, if there is an error message in the response from the LCS endpoint
Used in combination with either Enable-D365Exception cmdlet, or the -EnableException directly on this cmdlet, it will throw an exception and break/stop execution of the script This allows you to implement custom retry / error handling logic
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: 7
Default value: 00:00:00
Accept pipeline input: False
Accept wildcard characters: FalseThis 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Tags: Environment, Url, Config, Configuration, LCS, Upload, Api, AAD, Token, Deployment, Deploy
Author: Mötz Jensen (@Splaxi)
- Install as a non-Administrator
- Install as a Administrator
- Import d365fo.tools module
- List available commands from d365fo.tools module
- Get help content for a command
- Start, Stop and List services
- Import users into the D365FO environment
- Import external users into the D365FO environment
- Enable users in the D365FO environment
- Update users in the D365FO environment
- Provision D365FO environment to new Azure AD tenant
- Import a bacpac file into a Tier1 environment
- List modules / models
- Compile module
- Install AzCopy
- Install SqlPackage
- Install Nuget
- Speed up LCS download via AzCopy
- Download latest bacpac from LCS via AzCopy
- Register NuGet source
- Configure Azure Logic App
- Fix AzureStorageConfig
- Run a runnable class
- Update users in environment
- Work with Azure Storage Account
- Work with packages, resource label files, language and lables
- Working with the different D365 services