Share via

Outbound Network Dependencies Endpoints - List By Service

Service:
API Management
API Version:
2024-05-01

Gets the network endpoints of all outbound dependencies of a ApiManagement service.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints?api-version=2024-05-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

The name of the API Management service.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

OutboundEnvironmentEndpointList

OK
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementServiceGetOutboundNetworkDependenciesEndpoints

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/outboundNetworkDependenciesEndpoints?api-version=2024-05-01

Sample response

Status code:
200 
{
  "value": [
    {
      "category": "Azure SMTP",
      "endpoints": [
        {
          "domainName": "smtpi-ch1.msn.com",
          "endpointDetails": [
            {
              "port": 25028,
              "region": "West US"
            }
          ]
        }
      ]
    },
    {
      "category": "Azure SQL",
      "endpoints": [
        {
          "domainName": "xxxx1345234.database.windows.net",
          "endpointDetails": [
            {
              "port": 1433,
              "region": "West US"
            }
          ]
        }
      ]
    },
    {
      "category": "Azure Storage",
      "endpoints": [
        {
          "domainName": "xxxx32storagedgfbay.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx1362629927xt.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx1362629927xt.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx141483183xt.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx141483183xt.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx1949864718xt.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx1949864718xt.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx3292114122xt.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx3292114122xt.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx32tst4oto8t0mlesawmm.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx32tst4oto8t0mlesawmm.file.core.windows.net",
          "endpointDetails": [
            {
              "port": 445,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx32tst4oto8t0mlesawmm.queue.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx32tst4oto8t0mlesawmm.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            }
          ]
        }
      ]
    },
    {
      "category": "Azure Event Hub",
      "endpoints": [
        {
          "domainName": "xxxx1362629927eh.servicebus.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            },
            {
              "port": 5671,
              "region": "West US"
            },
            {
              "port": 5672,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx1949864718eh.servicebus.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            },
            {
              "port": 5671,
              "region": "West US"
            },
            {
              "port": 5672,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx3292114122eh.servicebus.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            },
            {
              "port": 5671,
              "region": "West US"
            },
            {
              "port": 5672,
              "region": "West US"
            }
          ]
        },
        {
          "domainName": "xxxx141483183eh.servicebus.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "West US"
            },
            {
              "port": 5671,
              "region": "West US"
            },
            {
              "port": 5672,
              "region": "West US"
            }
          ]
        }
      ]
    },
    {
      "category": "SSL Certificate Verification",
      "endpoints": [
        {
          "domainName": "ocsp.msocsp.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "mscrl.microsoft.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "crl.microsoft.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "crl3.digicert.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "ocsp.digicert.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "cacerts.digicert.com",
          "endpointDetails": [
            {
              "port": 80,
              "region": "Global"
            },
            {
              "port": 443,
              "region": "Global"
            }
          ]
        }
      ]
    },
    {
      "category": "Azure Monitor",
      "endpoints": [
        {
          "domainName": "gcs.ppe.monitoring.core.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "global.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "xxx3.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 1886,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "xxx3-red.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 1886,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "xxx3-black.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 1886,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "gcs.ppe.warm.ingestion.monitoring.azure.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "metrichost23.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "metrichost23-red.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "metrichost23-black.prod.microsoftmetrics.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        }
      ]
    },
    {
      "category": "Portal Captcha",
      "endpoints": [
        {
          "domainName": "client.xxx.live.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "partner.xxx.live.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        }
      ]
    },
    {
      "category": "Azure Active Directory",
      "endpoints": [
        {
          "domainName": "login.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "graph.windows.net",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        },
        {
          "domainName": "login.microsoftonline.com",
          "endpointDetails": [
            {
              "port": 443,
              "region": "Global"
            }
          ]
        }
      ]
    }
  ]
}

Definitions

Name Description
EndpointDependency

A domain name that a service is reached at.
EndpointDetail

Current TCP connectivity information from the Api Management Service to a single endpoint.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
OutboundEnvironmentEndpoint

Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.
OutboundEnvironmentEndpointList

Collection of Outbound Environment Endpoints

EndpointDependency

Object

A domain name that a service is reached at.

Name Type Description
domainName

string

The domain name of the dependency.
endpointDetails

EndpointDetail[]

The Ports used when connecting to DomainName.

EndpointDetail

Object

Current TCP connectivity information from the Api Management Service to a single endpoint.

Name Type Description
port

integer (int32)

The port an endpoint is connected to.
region

string

The region of the dependency.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

OutboundEnvironmentEndpoint

Object

Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.

Name Type Description
category

string

The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.
endpoints

EndpointDependency[]

The endpoints that the Api Management Service reaches the service at.

OutboundEnvironmentEndpointList

Object

Collection of Outbound Environment Endpoints

Name Type Description
nextLink

string

Link to next page of resources.
value

OutboundEnvironmentEndpoint[]

Collection of resources.