From 5e00606cb189b5e5ee661b3bf9310ad9ce307ce8 Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Thu, 1 Jul 2021 17:39:48 -0700 Subject: [PATCH] Vanguard: Get Outbound Network Dependency (#14900) * outbound dependency * fix resource --- .../apimoutbounddependency.json | 153 ++++++ ...tOutboundNetworkDependenciesEndpoints.json | 463 ++++++++++++++++++ .../apimanagement/resource-manager/readme.md | 1 + 3 files changed, 617 insertions(+) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json new file mode 100644 index 000000000000..9a589eb667bb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json @@ -0,0 +1,153 @@ +{ + "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": "2021-04-01-preview" + }, + "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": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.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" + } + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "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": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..1bb113394bdb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "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" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index d9f40a4f9d6d..56c77c0dbe28 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -60,6 +60,7 @@ input-file: - Microsoft.ApiManagement/preview/2021-04-01-preview/apimnetworkstatus.json - Microsoft.ApiManagement/preview/2021-04-01-preview/apimnotifications.json - Microsoft.ApiManagement/preview/2021-04-01-preview/apimopenidconnectproviders.json + - Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json - Microsoft.ApiManagement/preview/2021-04-01-preview/apimpolicies.json - Microsoft.ApiManagement/preview/2021-04-01-preview/apimpolicydescriptions.json - Microsoft.ApiManagement/preview/2021-04-01-preview/apimportalrevisions.json