diff --git a/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md index a253ee1215..211dee0b09 100644 --- a/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md +++ b/exchange/exchange-ps/ExchangePowerShell/ExchangePowerShell.md @@ -345,6 +345,8 @@ Exchange PowerShell is built on PowerShell technology to a powerful command-line ### [Remove-ContentFilterPhrase](Remove-ContentFilterPhrase.md) +### [Remove-DkimSigningConfig](Remove-DkimSigningConfig.md) + ### [Remove-EOPProtectionPolicyRule](Remove-EOPProtectionPolicyRule.md) ### [Remove-ExoPhishSimOverrideRule](Remove-ExoPhishSimOverrideRule.md) diff --git a/exchange/exchange-ps/ExchangePowerShell/Remove-DkimSigningConfig.md b/exchange/exchange-ps/ExchangePowerShell/Remove-DkimSigningConfig.md new file mode 100644 index 0000000000..addd191d7f --- /dev/null +++ b/exchange/exchange-ps/ExchangePowerShell/Remove-DkimSigningConfig.md @@ -0,0 +1,136 @@ +--- +applicable: Exchange Online, Exchange Online Protection +author: chrisda +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +Locale: en-US +Module Name: ExchangePowerShell +ms.author: chrisda +online version: https://learn.microsoft.com/powershell/module/exchangepowershell/remove-dkimsigningconfig +schema: 2.0.0 +title: Remove-DkimSigningConfig +--- + +# Remove-DkimSigningConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-DkimSigningConfig cmdlet to remove the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-DkimSigningConfig [-Identity] + [-Confirm] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-DkimSigningConfig -Identity contoso.com +``` + +This example removes the DKIM signing policy for the contoso.com domain. + +## PARAMETERS + +### -Identity + +> Applicable: Exchange Online, Exchange Online Protection + +The Identity parameter specifies the DKIM signing policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name: The domain name (for example, contoso.com). +- Distinguished name (DN) +- GUID + +```yaml +Type: DkimSigningConfigIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Exchange Online, Exchange Online Protection + +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Exchange Online, Exchange Online Protection + +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Exchange Online, Exchange Online Protection + +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 82c180e84a..5054473edd 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -159,6 +159,7 @@ "Remove-BlockedConnector": "antispam-antimalware", "Remove-BlockedSenderAddress": "antispam-antimalware", "Remove-ContentFilterPhrase": "antispam-antimalware", + "Remove-DkimSigningConfig": "antispam-antimalware", "Remove-EOPProtectionPolicyRule": "antispam-antimalware", "Remove-ExoPhishSimOverrideRule": "antispam-antimalware", "Remove-ExoSecOpsOverrideRule": "antispam-antimalware",