Commands › Exchange Online
Set-IPAllowListProvider
This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. Use the Set-IPAllowListProvider cmdlet to modify IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.
Quick start script
# Set-IPAllowListProvider — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-IPAllowListProvider
$before | Format-List
# 3. Make the change (dry run first)
Set-IPAllowListProvider -Identity <IPAllowListProviderIdParameter> -WhatIf
Set-IPAllowListProvider -Identity <IPAllowListProviderIdParameter>
# 4. Verify and diff
$after = Get-IPAllowListProvider
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-IPAllowListProvider [-Identity] <IPAllowListProviderIdParameter>
[-AnyMatch <Boolean>]
[-BitmaskMatch <IPAddress>]
[-Confirm]
[-DomainController <Fqdn>]
[-Enabled <Boolean>]
[-IPAddressesMatch <MultiValuedProperty>]
[-LookupDomain <SmtpDomain>]
[-Name <String>]
[-Priority <Int32>]
[-WhatIf]
[<CommonParameters>]Parameters (11)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | IPAllowListProviderIdParameter | yes | The Identity parameter specifies the IP Allow list provider that you want to modify. You can use any value that uniquely identifies the IP Allow list provider. For example: |
| -AnyMatch | Boolean | The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to... | |
| -BitmaskMatch | IPAddress | The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a... | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -DomainController | Fqdn | The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name... | |
| -Enabled | Boolean | The Enabled parameter specifies whether the Connection Filtering agent queries the IP Allow list provider according to the priority set for this IP Allow list provider configuration. Valid input for this parameter is... | |
| -IPAddressesMatch | MultiValuedProperty | The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input... | |
| -LookupDomain | SmtpDomain | The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An... | |
| -Name | String | The Name parameter specifies a descriptive name for the IP Allow list provider. | |
| -Priority | Int32 | The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you've configured. By default, every time that you add a new IP Allow list provider, the entry... | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.