Invoke-MgBetaForceDomainDelete

Module:

Microsoft.Graph.Beta.Identity.DirectoryManagement

Deletes a domain using an asynchronous operation. Prior to calling forceDelete, 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 will 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 will be returned in the response.

Note

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

Syntax

Invoke-MgBetaForceDomainDelete
      -DomainId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-DisableUserAccounts]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaForceDomainDelete
      -DomainId <String>
      -BodyParameter <IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaForceDomainDelete
      -InputObject <IIdentityDirectoryManagementIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-DisableUserAccounts]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaForceDomainDelete
      -InputObject <IIdentityDirectoryManagementIdentity>
      -BodyParameter <IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Deletes a domain using an asynchronous operation. Prior to calling forceDelete, 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 will 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 will be returned in the response.

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

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

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

Type:	IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-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

-DisableUserAccounts

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainId

The unique identifier of domain

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

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

Type:	IIdentityDirectoryManagementIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

Microsoft.Graph.Beta.PowerShell.Models.IPathsUasdopDomainsDomainIdMicrosoftGraphForcedeletePostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

System.Boolean

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
• [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration
• [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
• [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
• [ExtensionId <String>]: The unique identifier of extension
• [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile
• [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy
• [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
• [ManagedTenantAlertId <String>]: The unique identifier of managedTenantAlert
• [ManagementActionId <String>]: The unique identifier of managementAction
• [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
• [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
• [SubscribedSkuId <String>]: The unique identifier of subscribedSku
• [TenantId <String>]: The unique identifier of tenant
• [TenantReferenceTenantId <String>]: The unique identifier of tenantReference
• [TenantTagId <String>]: The unique identifier of tenantTag
• [UsageRightId <String>]: The unique identifier of usageRight
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.directorymanagement/invoke-mgbetaforcedomaindelete
• https://learn.microsoft.com/graph/api/domain-forcedelete?view=graph-rest-1.0