Microsoft 365 endpoint publication contract

This page's changes and edits · All guidance changes

Microsoft's edit · 26 Feb 23:42 UTC

m365-networking-edits-11220414

Microsoft's commit message in MicrosoftDocs/microsoft-365-docs · commit dbbcfef · +10 ~~−10~~ lines · also on GitHub

⋯ 181 unchanged lines

182182

183183 The result from the endpoints web method is an array of records in which each record represents a specific endpoint set. The elements for each record are:

184184

185 −- id—The immutable ID number of the endpoint set.

186 −- serviceArea—The service area that this is part of: `Common`, `Exchange`, `SharePoint`, or `Skype`.

187 −- urls—URLs for the endpoint set. A JSON array of DNS records. Omitted if blank.

188 −- tcpPorts—TCP ports for the endpoint set. All ports elements are formatted as a comma-separated list of ports or port ranges separated by a dash character (-). Ports apply to all IP addresses and all URLs in the endpoint set for a given category. Omitted if blank.

189 −- udpPorts—UDP ports for the IP address ranges in this endpoint set. Omitted if blank.

190 −- ips —The IP address ranges associated with this endpoint set as associated with the listed TCP or UDP ports. A JSON array of IP address ranges. Omitted if blank.

191 −- category—The connectivity category for the endpoint set. Valid values are `Optimize`, `Allow`, and `Default`. If you search the endpoints web method output for the category of a specific IP address or URL, it's possible that your query will return multiple categories. In such a case, follow the recommendation for the highest priority category. For example, if the endpoint appears in both `Optimize` and `Allow`, you should follow the requirements for `Optimize`. Required.

192 −- expressRoute — `True` if this endpoint set is routed over ExpressRoute, `False` if not.

193 −- required — `True` if this endpoint set is required to have connectivity for Microsoft 365 to be supported. `False` if this endpoint set is optional.

194 −- notes—For optional endpoints, this text describes Microsoft 365 functionality that would be unavailable if IP addresses or URLs in this endpoint set can't be accessed at the network layer. Omitted if blank.

185 +- **id** —The immutable ID number of the endpoint set.

186 +- **serviceArea** —The service area that this is part of: `Common`, `Exchange`, `SharePoint`, or `Skype`.

187 +- **urls** —URLs for the endpoint set. A JSON array of DNS records. Omitted if blank.

188 +- **tcpPorts** —TCP ports for the endpoint set. All ports elements are formatted as a comma-separated list of ports or port ranges separated by a dash character (-). Ports apply to all IP addresses and all URLs in the endpoint set for a given category. Omitted if blank.

189 +- **udpPorts**—UDP ports for the IP address ranges in this endpoint set. Omitted if blank.

190 +- **ips** —The IP address ranges associated with this endpoint set as associated with the listed TCP or UDP ports. A JSON array of IP address ranges. Omitted if blank.

191 +- **category** —The connectivity category for the endpoint set. Valid values are `Optimize`, `Allow`, and `Default`. If you search the endpoints web method output for the category of a specific IP address or URL, it's possible that your query will return multiple categories. In such a case, follow the recommendation for the highest priority category. For example, if the endpoint appears in both `Optimize` and `Allow`, you should follow the requirements for `Optimize`. Required.

192 +- **expressRoute** — `True` if this endpoint set is routed over ExpressRoute, `False` if not.

193 +- **required** — `True` if this endpoint set is required to have connectivity for Microsoft 365 to be supported. `False` if this endpoint set is optional.

194 +- **notes**—For optional endpoints, this text describes Microsoft 365 functionality that would be unavailable if IP addresses or URLs in this endpoint set can't be accessed at the network layer. Omitted if blank.

195195

196196 ### Endpoints web method examples

197197

⋯ 423 unchanged lines

Microsoft's Markdown source from MicrosoftDocs/microsoft-365-docs, © Microsoft Corporation, under CC BY 4.0. Changed lines with up to 3 unchanged lines around each; ChangeIntel kept this copy 10 Oct 05:18 UTC. The commit date is when the source changed, which can be hours or days before Learn published it.