Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Hub Generated] Review request for Microsoft.Web to add version 2018-02-01 #5137

Merged
merged 5 commits into from
Mar 4, 2019
Merged

[Hub Generated] Review request for Microsoft.Web to add version 2018-02-01 #5137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1bf8878
Add Hosting Environment network dependencies
dejo-msft Jan 31, 2019
b772c09
Address PR description feedback
derekj627 Feb 27, 2019
1ff1f6d
Add Network Dependencies examples
dejo-msft Feb 27, 2019
61d39f0
Fix casing
dejo-msft Mar 2, 2019
66114e5
Remove incorrect pagination from examples.
dejo-msft Mar 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 183 additions & 1 deletion ...fication/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,56 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": {
"get": {
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the network endpoints of all inbound dependencies of an App Service Environment.",
"description": "Get the network endpoints of all inbound dependencies of an App Service Environment.",
"operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InboundEnvironmentEndpoint"
}
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Inbound Network Dependencies Endpoints": {
"$ref": "./examples/GetInboundNetworkDependenciesEndpoints.json"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses paging, but this has not been called out here with an "x-ms-pageable" declaration. Please can you either update the example, or the schema, depending on whether or not you are using paging on this response?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The APIs are not paged. I've removed them from examples. Thanks for catching this!

}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": {
"get": {
"tags": [
Expand Down Expand Up @@ -1209,6 +1259,56 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": {
"get": {
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the network endpoints of all outbound dependencies of an App Service Environment.",
"description": "Get the network endpoints of all outbound dependencies of an App Service Environment.",
"operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/OutboundEnvironmentEndpoint"
}
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Outbound Network Dependencies Endpoints": {
"$ref": "./examples/GetOutboundNetworkDependenciesEndpoints.json"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses paging, but this has not been called out here with an "x-ms-pageable" declaration. Please can you either update the example, or the schema, depending on whether or not you are using paging on this response?

}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": {
"post": {
"tags": [
Expand Down Expand Up @@ -2163,6 +2263,47 @@
}
}
},
"EndpointDependency": {
"description": "A domain name that a service is reached at, including details of the current connection status.",
"type": "object",
"properties": {
"domainName": {
"description": "The domain name of the dependency.",
"type": "string"
},
"endpointDetails": {
"description": "The IP Addresses and Ports used when connecting to DomainName.",
"type": "array",
"items": {
"$ref": "#/definitions/EndpointDetail"
}
}
}
},
"EndpointDetail": {
"description": "Current TCP connectivity information from the App Service Environment to a single endpoint.",
"type": "object",
"properties": {
"ipAddress": {
"description": "An IP Address that Domain Name currently resolves to.",
"type": "string"
},
"port": {
"format": "int32",
"description": "The port an endpoint is connected to.",
"type": "integer"
},
"latency": {
"format": "double",
"description": "The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port.",
"type": "number"
},
"isAccessable": {
praries880 marked this conversation as resolved.
Show resolved Hide resolved
"description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.",
"type": "boolean"
}
}
},
"HostingEnvironmentDiagnostics": {
"description": "Diagnostics for an App Service Environment.",
"type": "object",
Expand All @@ -2177,6 +2318,30 @@
}
}
},
"InboundEnvironmentEndpoint": {
"description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.",
"type": "object",
"properties": {
"description": {
"description": "Short text describing the purpose of the network traffic.",
"type": "string"
},
"endpoints": {
"description": "The IP addresses that network traffic will originate from in cidr notation.",
"type": "array",
"items": {
"type": "string"
}
},
"ports": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that endpoints and ports are separate arrays, how does this work in practice? Each endpoint IP address supports each port?

"description": "The ports that network traffic will arrive to the App Service Environment at.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MetricAvailabilily": {
"description": "Metric availability and retention.",
"type": "object",
Expand Down Expand Up @@ -2231,6 +2396,23 @@
}
}
},
"OutboundEnvironmentEndpoint": {
praries880 marked this conversation as resolved.
Show resolved Hide resolved
"description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.",
"type": "object",
"properties": {
"category": {
"description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.",
"type": "string"
},
"endpoints": {
"description": "The endpoints that the App Service Environment reaches the service at.",
"type": "array",
"items": {
"$ref": "#/definitions/EndpointDependency"
}
}
}
},
"SkuInfo": {
"description": "SKU discovery information.",
"type": "object",
Expand Down Expand Up @@ -2467,4 +2649,4 @@
]
}
]
}
}
78 changes: 78 additions & 0 deletions ...ager/Microsoft.Web/stable/2018-02-01/examples/GetInboundNetworkDependenciesEndpoints.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "Sample-WestUSResourceGroup",
"name": "SampleAse",
"api-version": "2018-02-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"description": "App Service management",
"endpoints": [
"70.37.57.58/32",
"157.55.208.185/32",
"23.102.188.65/32",
"191.236.154.88/32",
"52.174.22.21/32",
"13.94.149.179/32",
"13.94.143.126/32",
"13.94.141.115/32",
"52.178.195.197/32",
"52.178.190.65/32",
"52.178.184.149/32",
"52.178.177.147/32",
"13.75.127.117/32",
"40.83.125.161/32",
"40.83.121.56/32",
"40.83.120.64/32",
"52.187.56.50/32",
"52.187.63.37/32",
"52.187.59.251/32",
"52.187.63.19/32",
"52.165.158.140/32",
"52.165.152.214/32",
"52.165.154.193/32",
"52.165.153.122/32",
"104.44.129.255/32",
"104.44.134.255/32",
"104.44.129.243/32",
"104.44.129.141/32",
"65.52.193.203/32",
"70.37.89.222/32",
"13.64.115.203/32",
"52.225.177.153/32",
"65.52.172.237/32"
],
"ports": [
"454",
"455"
]
},
{
"description": "App Service Environment VIP",
"endpoints": [
"52.247.209.18/32"
],
"ports": [
"454",
"455",
"16001"
]
},
{
"description": "App Service Environment subnet",
"endpoints": [
"192.168.250.0/24"
],
"ports": [
"All"
]
}
]
}
}
}
}
Loading