Share via

Disable-CrmOrganization

  • Reference
Module:
Microsoft.Crm.PowerShell

Disables the specified Microsoft Dynamics 365 organization.

Syntax

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.

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

Unique name of the the Dynamics 365 organization.

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

-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.Object