Share via

Invoke-MgBetaForceDomainDelete

Module:
Microsoft.Graph.Beta.Identity.DirectoryManagement Module

Delete a domain using an asynchronous operation. Before performing this operation, you must update or remove any references to Exchange as the provisioning service. The following actions are performed as part of this operation: After the domain deletion completes, API operations for the deleted domain return a 404 HTTP response code. To verify deletion of a domain, you can perform a get domain. If the domain was successfully deleted, a 404 HTTP response code is returned in the response.

Note

To view the v1.0 release of this cmdlet, view Invoke-MgForceDomainDelete

Syntax

ForceExpanded (Default) 

Invoke-MgBetaForceDomainDelete
    -DomainId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-DisableUserAccounts]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Force 

Invoke-MgBetaForceDomainDelete
    -DomainId <string>
    -BodyParameter <IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ForceViaIdentityExpanded 

Invoke-MgBetaForceDomainDelete
    -InputObject <IIdentityDirectoryManagementIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-DisableUserAccounts]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ForceViaIdentity 

Invoke-MgBetaForceDomainDelete
    -InputObject <IIdentityDirectoryManagementIdentity>
    -BodyParameter <IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Delete a domain using an asynchronous operation. Before performing this operation, you must update or remove any references to Exchange as the provisioning service. The following actions are performed as part of this operation: After the domain deletion completes, API operations for the deleted domain return a 404 HTTP response code. To verify deletion of a domain, you can perform a get domain. If the domain was successfully deleted, a 404 HTTP response code is returned in the response.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Domain.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Domain.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	disableUserAccounts = $true
}

Invoke-MgBetaForceDomainDelete -DomainId $domainId -BodyParameter $params

This example shows how to use the Invoke-MgBetaForceDomainDelete Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

ForceViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ForceExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema
Supports wildcards:False
DontShow:False

Parameter sets

ForceViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Force
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
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

-DisableUserAccounts

Delete a domain using an asynchronous operation. Before performing this operation, you must update or remove any references to Exchange as the provisioning service. The following actions are performed as part of this operation: After the domain deletion completes, API operations for the deleted domain return a 404 HTTP response code. To verify deletion of a domain, you can perform a get domain. If the domain was successfully deleted, a 404 HTTP response code is returned in the response.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Domain.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Domain.ReadWrite.All,

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

ForceViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ForceExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DomainId

The unique identifier of domain

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

ForceExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Force
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
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

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

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

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity
Supports wildcards:False
DontShow:False

Parameter sets

ForceViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ForceViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
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

CommonParameters

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

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

System.Boolean

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema>: . [(Any) <Object>]: This indicates any property can be added to this object. [DisableUserAccounts <Boolean?>]:

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit [AllowedValueId <String>]: The unique identifier of allowedValue [AttributeSetId <String>]: The unique identifier of attributeSet [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity [CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration [CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki [CommandId <String>]: The unique identifier of command [CommerceSubscriptionId <String>]: Alternate key of companySubscription [CompanySubscriptionId <String>]: The unique identifier of companySubscription [ContractId <String>]: The unique identifier of contract [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition [DeviceId <String>]: The unique identifier of device [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo [DeviceTemplateId <String>]: The unique identifier of deviceTemplate [DirectoryObjectId <String>]: The unique identifier of directoryObject [DirectoryRoleId <String>]: The unique identifier of directoryRole [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate [DirectorySettingId <String>]: The unique identifier of directorySetting [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord [DomainId <String>]: The unique identifier of domain [DomainName <String>]: Usage: domainName='{domainName}' [ExtensionId <String>]: The unique identifier of extension [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy [HardwareOathTokenAuthenticationMethodDeviceId <String>]: The unique identifier of hardwareOathTokenAuthenticationMethodDevice [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase [ImpactedResourceId <String>]: The unique identifier of impactedResource [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation [MutualTlsOauthConfigurationId <String>]: The unique identifier of mutualTlsOauthConfiguration [OcpSubscriptionId <String>]: Alternate key of companySubscription [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization [OrgContactId <String>]: The unique identifier of orgContact [OrganizationId <String>]: The unique identifier of organization [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty [ProfilePropertySettingId <String>]: The unique identifier of profilePropertySetting [ProfileSourceId <String>]: The unique identifier of profileSource [RecommendationId <String>]: The unique identifier of recommendation [RoleTemplateId <String>]: Alternate key of directoryRole [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation [SourceId <String>]: Alternate key of profileSource [SubscribedSkuId <String>]: The unique identifier of subscribedSku [TenantId <String>]: Usage: tenantId='{tenantId}' [TenantReferenceTenantId <String>]: The unique identifier of tenantReference [UsageRightId <String>]: The unique identifier of usageRight [UserId <String>]: The unique identifier of user