format_ipv4()
Learn how to use the format_ipv4() function to parse the input with a netmask and return a string representing the IPv4 address.
Parses the input with a netmask and returns a string representing the IPv4 address.
Syntax
format_ipv4(ip [, prefix])
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ip | string | ✔️ | The IPv4 address. The format may be a string or number representation in big-endian order. |
| prefix | int | An integer from 0 to 32 representing the number of most-significant bits that are taken into account. If unspecified, all 32 bit-masks are used. |
Returns
If conversion is successful, the result will be a string representing IPv4 address. If conversion isn’t successful, the result will be an empty string.
Examples
datatable(address:string, mask:long)
[
'192.168.1.1', 24,
'192.168.1.1', 32,
'192.168.1.1/24', 32,
'192.168.1.1/24', long(-1),
]
| extend result = format_ipv4(address, mask),
result_mask = format_ipv4_mask(address, mask)
Output
| address | mask | result | result_mask |
|---|---|---|---|
| 192.168.1.1 | 24 | 192.168.1.0 | 192.168.1.0/24 |
| 192.168.1.1 | 32 | 192.168.1.1 | 192.168.1.1/32 |
| 192.168.1.1/24 | 32 | 192.168.1.0 | 192.168.1.0/24 |
| 192.168.1.1/24 | -1 |
Related content
- For IPv4 address formatting including CIDR notation, see format_ipv4_mask().
- For a list of functions related to IP addresses, see IPv4 and IPv6 functions.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.