{ "swagger": "2.0", "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for getting the outbound network dependency of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", "version": "2024-05-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints": { "get": { "tags": [ "OutboundNetworkDependenciesEndpoints" ], "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", "description": "Gets the network endpoints of all outbound dependencies of a ApiManagement service.", "x-ms-examples": { "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints": { "$ref": "./examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OutboundEnvironmentEndpointList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "OutboundEnvironmentEndpointList": { "description": "Collection of Outbound Environment Endpoints", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/OutboundEnvironmentEndpoint" }, "x-ms-identifiers": [] }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "OutboundEnvironmentEndpoint": { "description": "Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.", "type": "object", "properties": { "category": { "description": "The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", "type": "string" }, "endpoints": { "description": "The endpoints that the Api Management Service reaches the service at.", "type": "array", "items": { "$ref": "#/definitions/EndpointDependency" }, "x-ms-identifiers": [ "domainName" ] } } }, "EndpointDependency": { "description": "A domain name that a service is reached at.", "type": "object", "properties": { "domainName": { "description": "The domain name of the dependency.", "type": "string" }, "endpointDetails": { "description": "The Ports used when connecting to DomainName.", "type": "array", "items": { "$ref": "#/definitions/EndpointDetail" }, "x-ms-identifiers": [ "region", "port" ] } } }, "EndpointDetail": { "description": "Current TCP connectivity information from the Api Management Service to a single endpoint.", "type": "object", "properties": { "port": { "format": "int32", "description": "The port an endpoint is connected to.", "type": "integer" }, "region": { "description": "The region of the dependency.", "type": "string" } } } }, "parameters": {} }