Share via


Edit-CrmOrganization

Edits properties of the specified Dynamics 365 organization.

Syntax

Default (Default)

Edit-CrmOrganization
    [-Name] <String>
    [[-DisplayName] <String>]
    [[-SqlServerName] <String>]
    [[-SrsUrl] <String>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]
    [-WhatIf]
    [-Confirm]

Description

The Edit-CrmOrganization cmdlet allows you to edit the Display Name, SQL Server name, and Reporting Services URL properties of an organization. The organization must first be disabled before it can be edited. See the Disable-CrmOrganization cmdlet for details on disabling a Dynamics 365 organization.

Examples

Example 1

PS C:\> Edit-CrmOrganization -Name Contoso -DisplayName 'Contoso Sales'

Modifies the display name of the organization Contoso to Contoso Sales.

Example 2

PS C:\> Edit-CrmOrganization -Name Contoso -SrsUrl http://mySRSServer/ReportServer

Modifies the Microsoft SQL Server Reporting Services report server URL for the organization Contoso to point to the Reporting Services report server at http://mySRSServer/ReportServer.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Specifies the friendly name of the organization.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-DwsServerUrl

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the unique name for the Dynamics 365 organization.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SqlServerName

Specifies the SQL Server name for the Dynamics 365 organization.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SrsUrl

Specifies the Microsoft SQL Server Reporting Services URL for the Dynamics 365 organization.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Timeout

For internal use only.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

Inputs

System.String

System.Int32

System.Management.Automation.SwitchParameter

System.Management.Automation.PSCredential

Outputs

System.Object