forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Vanguard: Get Outbound Network Dependency (Azure#14900)
* outbound dependency * fix resource
- Loading branch information
1 parent
5ba3a75
commit 5e00606
Showing
3 changed files
with
617 additions
and
0 deletions.
There are no files selected for viewing
153 changes: 153 additions & 0 deletions
153
...ce-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimoutbounddependency.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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": {} | ||
} |
Oops, something went wrong.