Update-CrmOrganization

  • Reference
Module:
Microsoft.Crm.PowerShell

Updates the specified Dynamics 365 organization with the latest software updates or upgrades the organization to the latest available Dynamics 365 release.

Syntax

Update-CrmOrganization
      [-Name] <String>
      [-Upgrade]
      [-Timeout <Int32>]
      [-Diag]
      [-Credential <PSCredential>]
      [-DwsServerUrl <String>]
      [-WhatIf]
      [-Confirm]

Description

The Update-CrmOrganization cmdlet updates the specified Dynamics 365 organization with the latest software updates or upgrades the organization to the latest available Dynamics 365 release on the Dynamics 365 server.

Examples

Example 1

PS C:\> $UpgradeOpId = Update-CrmOrganization -Name Contoso -Upgrade

Begins the upgrade process and returns the operation Id. This upgrades the Dynamics 365 database to the latest release and applies all available updates. You can see the progress of the operation with the PowerShell command Get-CrmOperationStatus -OperationId $UpgradeOpId.

Example 1

PS C:\> $UpdateOpId = Update-CrmOrganization -Name Contoso

Begins the update process and returns the operation ID. This command applies all available updates. You can see the progress of the operation with the PowerShell command Get-CrmOperationStatus -OperationId $UpdateOpId.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Diag

Turns on stack traces for error reports returned from Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DwsServerUrl

The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the unique name of the organization to update or upgrade.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

For internal use only.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Upgrade

Specifies whether to upgrade the organization. This parameter is optional.

Type:SwitchParameter
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential

Outputs

System.Guid