Share via


Disable-CrmOrganization

Disables the specified Microsoft Dynamics 365 organization.

Syntax

Default (Default)

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

Description

The Disable-CrmOrganization cmdlet disables the Dynamics 365 organization specified by the Name parameter. The administrator must provide the unique name of the organization to disable. An organization would be disabled to perform database maintenance or as a precursor to being deleted.

Examples

Example 1

PS C:\> Disable-CrmOrganization -Name Contoso

Disables the Dynamics 365 organization named Contoso.

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

-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

Unique name of the 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

-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