Enable-CrmAdminMode
Enables administration mode on a sandbox environment.
Syntax
Enable-CrmAdminMode
[-AdminModeSettings <InstanceAdminModeSettings>]
-InstanceId <Guid>
[-ValidateOnly]
[-ApiUrl] <Uri>
[[-Credential] <PSCredential>]
[-MaxCrmConnectionTimeOutMinutes <Int32>]
Description
The Enable-CrmAdminMode cmdlet enables administration mode on a sandbox environment. When you place a sandbox environment in administration mode only users with System Administrator or System Customizer security roles will be able to sign in to that environment. Administration mode is useful when you want to make operational changes and not have regular users affect your work, and not have your work affect regular users.
You can find whether a sandbox environment is enabled for administration mode by running the Get-CrmInstances cmdlet.
Examples
Example 1
PS C:\> Enable-CrmAdminMode -InstanceId <Instance Id> -ValidateOnly -ApiUrl $connectionhost -Credential $cred
Validates whether the specified environment can be enabled for administration mode.
Example 2
PS C:\> Enable-CrmAdminMode -InstanceId <Instance Id> -AdminModeSettings $MyAdminModeSetting -ApiUrl $connectionhost -Credential $cred
Enables the specified environment for administration mode using the $MyAdminModeSetting object created by running the New-CrmAdminModeSetting cmdlet.
Parameters
-AdminModeSettings
You create the object for this parameter by running the New-CrmAdminModeSetting cmdlet.
Type: | InstanceAdminModeSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApiUrl
URL of the Dataverse root service endpoint. For information about this parameter see Establish your credentials and connection.
Type: | Uri |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Credential
User credential for signing in to Dataverse. For information about this parameter see Establish your credentials and connection.
Type: | PSCredential |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InstanceId
Id for the specific Dataverse environment. Use the Get-CrmInstances cmdlet to find all Ids within the same tenant.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MaxCrmConnectionTimeOutMinutes
Maximum number in minutes to wait before quitting the operation.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ValidateOnly
Validates whether the operation will succeed without committing any changes.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Microsoft.Xrm.Services.Admin.Client.Models.InstanceAdminModeSettings
System.Guid System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32
Outputs
System.Object