Edit-CrmOrganization

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Edit-CrmOrganization

Edits properties of the specified Microsoft Dynamics 365 organization.

Syntax

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

Detailed 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 Microsoft Dynamics 365 organization.

Parameters

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Diag

Turns on stack traces for error reports returned from Microsoft 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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-DisplayName<String>

Specifies the display name for the Microsoft Dynamics 365 organization.

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-DwsServerUrl<String>

Specifies the location of the Deployment web service. This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the unique name for the Microsoft Dynamics 365 organization.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-SqlServerName<String>

Specifies the SQL Server name for the Microsoft Dynamics 365 organization.

Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-SrsUrl<String>

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

Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Timeout<Int32>

For internal use only.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------------------- EXAMPLE 1 --------------------------

This example modifies the display name of the organization “Contoso” to be “ContosoSales.”

PS C:\> Edit-CrmOrganization –Name Contoso –DisplayName ContosoSales

-------------------------- EXAMPLE 2 --------------------------

This example 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.

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