From 88be99d60f23e6e7183f65d7ea12c29d6ec81593 Mon Sep 17 00:00:00 2001 From: Anton Evseev Date: Tue, 26 Mar 2019 16:16:47 +0300 Subject: [PATCH 1/2] Added missing descriptions in Network specs --- .../stable/2019-02-01/applicationGateway.json | 63 ++++++++---- .../stable/2019-02-01/azureFirewall.json | 35 ++++--- .../2019-02-01/azureFirewallFqdnTag.json | 3 +- .../2019-02-01/expressRouteCircuit.json | 30 ++++-- .../expressRouteCrossConnection.json | 12 ++- .../2019-02-01/expressRouteGateway.json | 8 +- .../stable/2019-02-01/loadBalancer.json | 9 +- .../stable/2019-02-01/network.json | 33 ++++--- .../stable/2019-02-01/networkProfile.json | 3 +- .../stable/2019-02-01/networkWatcher.json | 97 ++++++++++++------- .../stable/2019-02-01/publicIpPrefix.json | 3 +- .../stable/2019-02-01/routeFilter.json | 12 ++- .../stable/2019-02-01/serviceCommunity.json | 3 +- .../stable/2019-02-01/virtualNetwork.json | 9 +- .../stable/2019-02-01/virtualWan.json | 33 ++++--- 15 files changed, 231 insertions(+), 122 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json index 39c3cfbb8db3..87316c95a0a5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json @@ -707,10 +707,11 @@ "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" - } + }, + "description": "A list of ApplicationGatewayBackendHealthPool resources." } }, - "description": "List of ApplicationGatewayBackendHealthPool resources." + "description": "Response for ApplicationGatewayBackendHealth API service call." }, "ApplicationGatewayBackendHealthPool": { "properties": { @@ -878,7 +879,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway IP configuration." }, "name": { "type": "string", @@ -917,7 +919,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", + "description": "Properties of the application gateway authentication certificate." }, "name": { "type": "string", @@ -960,7 +963,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted root certificate." }, "name": { "type": "string", @@ -1011,7 +1015,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", + "description": "Properties of the application gateway SSL certificate." }, "name": { "type": "string", @@ -1070,7 +1075,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway frontend IP configuration." }, "name": { "type": "string", @@ -1110,7 +1116,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", + "description": "Properties of the application gateway frontend port." }, "name": { "type": "string", @@ -1172,7 +1179,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", + "description": "Properties of the application gateway backend address pool." }, "name": { "type": "string", @@ -1283,7 +1291,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", + "description": "Properties of the application gateway backend HTTP settings." }, "name": { "type": "string", @@ -1357,7 +1366,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", + "description": "Properties of the application gateway HTTP listener." }, "name": { "type": "string", @@ -1415,7 +1425,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", + "description": "Properties of the application gateway path rule." }, "name": { "type": "string", @@ -1514,7 +1525,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", + "description": "Properties of the application gateway probe." }, "name": { "type": "string", @@ -1585,7 +1597,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", + "description": "Properties of the application gateway request routing rule." }, "name": { "type": "string", @@ -1611,7 +1624,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", + "description": "Properties of the application gateway rewrite rule set." }, "name": { "type": "string", @@ -1780,7 +1794,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", + "description": "Properties of the application gateway redirect configuration." }, "name": { "type": "string", @@ -1967,7 +1982,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", + "description": "Properties of the application gateway." }, "etag": { "type": "string", @@ -2044,7 +2060,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", + "description": "Properties of the application gateway URL path map." }, "name": { "type": "string", @@ -2270,7 +2287,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", + "description": "Properties of the application gateway firewall rule set." } }, "allOf": [ @@ -2354,7 +2372,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", + "description": "Properties of the application gateway available SSL options." } }, "allOf": [ @@ -2418,7 +2437,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat" + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", + "description": "Properties of the application gateway SSDL predefined policy." } }, "allOf": [ @@ -2528,6 +2548,7 @@ }, "RedirectTypeEnum": { "type": "string", + "description": "Redirect type enum.", "enum": [ "Permanent", "Found", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json index 7278a0c0e5ad..366c5fed2a7e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json @@ -281,9 +281,10 @@ }, "AzureFirewallIPConfiguration":{ "properties":{ - "properties":{ - "x-ms-client-flatten":true, - "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallIPConfigurationPropertiesFormat", + "description": "Properties of the azure firewall IP configuration." }, "name":{ "type":"string", @@ -345,9 +346,10 @@ }, "AzureFirewall":{ "properties":{ - "properties":{ - "x-ms-client-flatten":true, - "$ref":"#/definitions/AzureFirewallPropertiesFormat" + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallPropertiesFormat", + "description": "Properties of the azure firewall." }, "etag":{ "type":"string", @@ -422,9 +424,10 @@ }, "AzureFirewallApplicationRuleCollection":{ "properties":{ - "properties":{ - "x-ms-client-flatten":true, - "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall application rule collection." }, "name":{ "type":"string", @@ -533,9 +536,10 @@ }, "AzureFirewallNatRuleCollection":{ "properties":{ - "properties":{ - "x-ms-client-flatten":true, - "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties" + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNatRuleCollectionProperties", + "description": "Properties of the azure firewall NAT rule collection." }, "name":{ "type":"string", @@ -655,9 +659,10 @@ }, "AzureFirewallNetworkRuleCollection":{ "properties":{ - "properties":{ - "x-ms-client-flatten":true, - "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall network rule collection." }, "name":{ "type":"string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json index af30d606d7fd..ccc8a0f9e5fd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json @@ -88,7 +88,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat" + "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat", + "description": "Properties of the azure firewall FQDN tag." }, "etag": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json index 2d3303bd668e..7f78b3032c19 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json @@ -1389,13 +1389,15 @@ "type": "string", "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } - } + }, + "description": "Properties of ExpressRouteCircuitAuthorization." }, "ExpressRouteCircuitAuthorization": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationPropertiesFormat" + "$ref": "#/definitions/AuthorizationPropertiesFormat", + "description": "Properties of the express route circuit authorization." }, "name": { "type": "string", @@ -1629,13 +1631,15 @@ "readOnly": true, "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit." } - } + }, + "description": "Properties of the express route circuit peering." }, "ExpressRouteCircuitPeering": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat", + "description": "Properties of the express route circuit peering." }, "name": { "type": "string", @@ -1732,13 +1736,15 @@ "readOnly": true, "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } - } + }, + "description": "Properties of the express route circuit connection." }, "ExpressRouteCircuitConnection": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat" + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the express route circuit connection." }, "name": { "type": "string", @@ -1814,13 +1820,15 @@ "readOnly": true, "description": "Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } - } + }, + "description": "Properties of the peer express route circuit connection." }, "PeerExpressRouteCircuitConnection": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat" + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the peer express route circuit connection." }, "name": { "type": "string", @@ -1999,7 +2007,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat", + "description": "Properties of the express route circuit." }, "etag": { "readOnly": true, @@ -2194,7 +2203,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat" + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat", + "description": "Properties of the express route service provider." } }, "allOf": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCrossConnection.json index 07948cd0d763..f294f62f7f71 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCrossConnection.json @@ -704,7 +704,8 @@ "type":"string", "description": "Corresponding Express Route Circuit Id." } - } + }, + "description": "Reference to an express route circuit." }, "ExpressRouteCrossConnectionProperties": { "properties": { @@ -773,7 +774,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteCrossConnectionProperties" + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties", + "description": "Properties of the express route cross connection." }, "etag": { "readOnly": true, @@ -876,13 +878,15 @@ "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", "description": "The IPv6 peering configuration." } - } + }, + "description": "Properties of express route cross connection peering." }, "ExpressRouteCrossConnectionPeering": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties" + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties", + "description": "Properties of the express route cross connection peering." }, "name": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteGateway.json index b3e99e625d10..b5f52b952172 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteGateway.json @@ -549,7 +549,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteGatewayProperties" + "$ref": "#/definitions/ExpressRouteGatewayProperties", + "description": "Properties of the express route gateway." }, "etag": { "type": "string", @@ -618,7 +619,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ExpressRouteConnectionProperties" + "$ref": "#/definitions/ExpressRouteConnectionProperties", + "description": "Properties of the express route connection." }, "name": { "type": "string", @@ -645,4 +647,4 @@ "description": "ExpressRouteConnection list" } } -} \ No newline at end of file +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json index 75816f426ceb..f61805912508 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json @@ -1221,7 +1221,8 @@ "description": "The reference of the load balancer probe used by the load balancing rule." }, "protocol": { - "$ref": "#/definitions/TransportProtocol" + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the load balancing rule." }, "loadDistribution": { "type": "string", @@ -1385,7 +1386,8 @@ "description": "A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP." }, "protocol": { - "$ref": "#/definitions/TransportProtocol" + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the load balancing rule." }, "frontendPort": { "type": "integer", @@ -1447,7 +1449,8 @@ "description": "A reference to frontend IP addresses." }, "protocol": { - "$ref": "#/definitions/TransportProtocol" + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the inbound NAT pool." }, "frontendPortRangeStart": { "type": "integer", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/network.json index 8d839ac6e7ef..a72b7b2268aa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/network.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/network.json @@ -39,37 +39,47 @@ "ErrorDetails": { "properties": { "code": { - "type": "string" + "type": "string", + "description": "Error code." }, "target": { - "type": "string" + "type": "string", + "description": "Error target." }, "message": { - "type": "string" + "type": "string", + "description": "Error message." } - } + }, + "description": "Common error details representation." }, "Error": { "properties": { "code": { - "type": "string" + "type": "string", + "description": "Error code." }, "message": { - "type": "string" + "type": "string", + "description": "Error message." }, "target": { - "type": "string" + "type": "string", + "description": "Error target." }, "details": { "type": "array", "items": { "$ref": "#/definitions/ErrorDetails" - } + }, + "description": "Error details." }, "innerError": { - "type": "string" + "type": "string", + "description": "Inner error message." } - } + }, + "description": "Common error representation." }, "AzureAsyncOperationResult": { "properties": { @@ -87,7 +97,8 @@ } }, "error": { - "$ref": "#/definitions/Error" + "$ref": "#/definitions/Error", + "description": "Details of the error occurred during specified asynchronous operation." } }, "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkProfile.json index ed42be663513..5b3fcb330f55 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkProfile.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkProfile.json @@ -405,7 +405,8 @@ "type": "string", "description": "The provisioning state of the resource." } - } + }, + "description": "Properties of container network interface." }, "ContainerNetworkInterface": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkWatcher.json index 64a9609fa864..1d71e88b5dca 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/networkWatcher.json @@ -1864,7 +1864,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" + "$ref": "#/definitions/NetworkWatcherPropertiesFormat", + "description": "Properties of the network watcher." } }, "allOf": [ @@ -1900,10 +1901,11 @@ "type": "array", "items": { "$ref": "#/definitions/NetworkWatcher" - } + }, + "description": "List of network watcher resources." } }, - "description": "List of network watcher resources." + "description": "Response for ListNetworkWatchers API service call." }, "TopologyParameters": { "properties": { @@ -1945,7 +1947,8 @@ "type": "array", "items": { "$ref": "#/definitions/TopologyResource" - } + }, + "description": "A list of topology resources." } }, "description": "Topology of the specified resource group." @@ -2169,7 +2172,8 @@ "description": "ID of the network interface." }, "securityRuleAssociations": { - "$ref": "#/definitions/SecurityRuleAssociations" + "$ref": "#/definitions/SecurityRuleAssociations", + "description": "All security rules associated with the network interface." } } }, @@ -2177,10 +2181,12 @@ "description": "All security rules associated with the network interface.", "properties": { "networkInterfaceAssociation": { - "$ref": "#/definitions/NetworkInterfaceAssociation" + "$ref": "#/definitions/NetworkInterfaceAssociation", + "description": "Network interface and it's custom security rules." }, "subnetAssociation": { - "$ref": "#/definitions/SubnetAssociation" + "$ref": "#/definitions/SubnetAssociation", + "description": "Subnet and it's custom security rules." }, "defaultSecurityRules": { "type": "array", @@ -2216,7 +2222,7 @@ } }, "SubnetAssociation": { - "description": "Network interface and its custom security rules.", + "description": "Subnet and it's custom security rules.", "properties": { "id": { "readOnly": true, @@ -2236,7 +2242,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/PacketCaptureParameters" + "$ref": "#/definitions/PacketCaptureParameters", + "description": "Properties of the packet capture." } }, "required": [ @@ -2266,13 +2273,15 @@ "description": "Maximum duration of the capture session in seconds." }, "storageLocation": { - "$ref": "#/definitions/PacketCaptureStorageLocation" + "$ref": "#/definitions/PacketCaptureStorageLocation", + "description": "Describes the storage location for a packet capture session." }, "filters": { "type": "array", "items": { "$ref": "#/definitions/PacketCaptureFilter" - } + }, + "description": "A list of packet capture filters." } }, "required": [ @@ -2359,11 +2368,13 @@ }, "etag": { "type": "string", - "default": "A unique read-only string that changes whenever the resource is updated." + "default": "A unique read-only string that changes whenever the resource is updated.", + "description": "A unique read-only string that changes whenever the resource is updated." }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/PacketCaptureResultProperties" + "$ref": "#/definitions/PacketCaptureResultProperties", + "description": "Properties of the packet capture result." } }, "description": "Information about packet capture session." @@ -2460,7 +2471,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/TroubleshootingProperties" + "$ref": "#/definitions/TroubleshootingProperties", + "description": "Properties of the troubleshooting resource." } } }, @@ -2584,10 +2596,12 @@ "type": "boolean" }, "retentionPolicy": { - "$ref": "#/definitions/RetentionPolicyParameters" + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." }, "format": { - "$ref": "#/definitions/FlowLogFormatParameters" + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." } } }, @@ -2652,10 +2666,12 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/FlowLogProperties" + "$ref": "#/definitions/FlowLogProperties", + "description": "Properties of the flow log." }, "flowAnalyticsConfiguration": { - "$ref": "#/definitions/TrafficAnalyticsProperties" + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." } } }, @@ -2666,7 +2682,8 @@ ], "properties": { "networkWatcherFlowAnalyticsConfiguration": { - "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties" + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties", + "description": "Parameters that define the configuration of traffic analytics." } } }, @@ -2709,10 +2726,12 @@ ], "properties": { "source": { - "$ref": "#/definitions/ConnectivitySource" + "$ref": "#/definitions/ConnectivitySource", + "description": "Describes the source of the connection." }, "destination": { - "$ref": "#/definitions/ConnectivityDestination" + "$ref": "#/definitions/ConnectivityDestination", + "description": "Describes the destination of connection." }, "protocol": { "type": "string", @@ -2729,7 +2748,8 @@ } }, "protocolConfiguration": { - "$ref": "#/definitions/ProtocolConfiguration" + "$ref": "#/definitions/ProtocolConfiguration", + "description": "Configuration of the protocol." } } }, @@ -2931,7 +2951,8 @@ "description": "Configuration of the protocol.", "properties": { "HTTPConfiguration": { - "$ref": "#/definitions/HTTPConfiguration" + "$ref": "#/definitions/HTTPConfiguration", + "description": "HTTP configuration of the connectivity check." } } }, @@ -2981,7 +3002,8 @@ "AzureReachabilityReportParameters": { "properties": { "providerLocation": { - "$ref": "#/definitions/AzureReachabilityReportLocation" + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." }, "providers": { "type": "array", @@ -3042,7 +3064,8 @@ "description": "The aggregation level of Azure reachability report. Can be Country, State or City." }, "providerLocation": { - "$ref": "#/definitions/AzureReachabilityReportLocation" + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." }, "reachabilityReport": { "type": "array", @@ -3211,7 +3234,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ConnectionMonitorParameters" + "$ref": "#/definitions/ConnectionMonitorParameters", + "description": "Properties of the connection monitor." } }, "required": [ @@ -3222,10 +3246,12 @@ "ConnectionMonitorParameters": { "properties": { "source": { - "$ref": "#/definitions/ConnectionMonitorSource" + "$ref": "#/definitions/ConnectionMonitorSource", + "description": "Describes the source of connection monitor." }, "destination": { - "$ref": "#/definitions/ConnectionMonitorDestination" + "$ref": "#/definitions/ConnectionMonitorDestination", + "description": "Describes the destination of connection monitor." }, "autoStart": { "type": "boolean", @@ -3304,7 +3330,8 @@ }, "etag": { "type": "string", - "default": "A unique read-only string that changes whenever the resource is updated." + "default": "A unique read-only string that changes whenever the resource is updated.", + "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, @@ -3324,7 +3351,8 @@ }, "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ConnectionMonitorResultProperties" + "$ref": "#/definitions/ConnectionMonitorResultProperties", + "description": "Properties of the connection monitor result." } }, "description": "Information about the connection monitor." @@ -3546,10 +3574,12 @@ "description": "Network configuration diagnostic result corresponded to provided traffic query.", "properties": { "profile": { - "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile", + "description": "Network configuration diagnostic profile." }, "networkSecurityGroupResult": { - "$ref": "#/definitions/NetworkSecurityGroupResult" + "$ref": "#/definitions/NetworkSecurityGroupResult", + "description": "Network security group result." } } }, @@ -3590,7 +3620,8 @@ "description": "Resource ID of nic or subnet to which network security group is applied." }, "matchedRule": { - "$ref": "#/definitions/MatchedRule" + "$ref": "#/definitions/MatchedRule", + "description": "Matched network security rule." }, "rulesEvaluationResult": { "readOnly": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpPrefix.json index bd5ce00cf320..b380433dc873 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpPrefix.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpPrefix.json @@ -421,7 +421,8 @@ "type":"string", "description":"The PublicIPAddress Reference" } - } + }, + "description": "Reference to a public IP address." } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/routeFilter.json index fb778822ee08..3a2c598dbdae 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/routeFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/routeFilter.json @@ -618,7 +618,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." }, "name": { "type": "string", @@ -645,7 +646,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." }, "name": { "type": "string", @@ -696,7 +698,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/RouteFilterPropertiesFormat" + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." }, "etag": { "type": "string", @@ -715,7 +718,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/RouteFilterPropertiesFormat" + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." }, "name": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/serviceCommunity.json index 3252e04b66e9..984fca51cb83 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/serviceCommunity.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/serviceCommunity.json @@ -119,7 +119,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat" + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat", + "description": "Properties of the BGP service community." } }, "allOf": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualNetwork.json index b7364c5862ca..e848c6f760eb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualNetwork.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualNetwork.json @@ -1450,7 +1450,8 @@ }, "description": "A list of NetworkIntentPolicyConfiguration." } - } + }, + "description": "Details of PrepareNetworkPolicies for Subnet." }, "NetworkIntentPolicyConfiguration": { "properties": { @@ -1459,9 +1460,11 @@ "description": "The name of the Network Intent Policy for storing in target subscription." }, "sourceNetworkIntentPolicy": { - "$ref": "#/definitions/NetworkIntentPolicy" + "$ref": "#/definitions/NetworkIntentPolicy", + "description": "Source network intent policy." } - } + }, + "description": "Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest." }, "NetworkIntentPolicy": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualWan.json index bc71744f83fd..4184c597fbed 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/virtualWan.json @@ -2274,7 +2274,8 @@ "readOnly": true, "items": { "$ref": "./network.json#/definitions/SubResource" - } + }, + "description": "List of VpnSites in the VirtualWAN." }, "securityProviderName": { "type": "string", @@ -2313,7 +2314,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualWanProperties" + "$ref": "#/definitions/VirtualWanProperties", + "description": "Properties of the virtual WAN." }, "etag": { "type": "string", @@ -2388,7 +2390,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/VpnSiteProperties" + "$ref": "#/definitions/VpnSiteProperties", + "description": "Properties of the VPN site." }, "etag": { "type": "string", @@ -2510,7 +2513,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualHubProperties" + "$ref": "#/definitions/VirtualHubProperties", + "description": "Properties of the virtual hub." }, "etag": { "type": "string", @@ -2577,7 +2581,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/VpnGatewayProperties" + "$ref": "#/definitions/VpnGatewayProperties", + "description": "Properties of the VPN gateway." }, "etag": { "type": "string", @@ -2678,7 +2683,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/VpnConnectionProperties" + "$ref": "#/definitions/VpnConnectionProperties", + "description": "Properties of the VPN connection." }, "name": { "type": "string", @@ -2742,7 +2748,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/HubVirtualNetworkConnectionProperties" + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", + "description": "Properties of the hub virtual network connection." }, "name": { "type": "string", @@ -2811,7 +2818,8 @@ "type": "array", "items": { "$ref": "#/definitions/VirtualWanSecurityProvider" - } + }, + "description": "List of VirtualWAN security providers." } }, "description": "Collection of SecurityProviders." @@ -3153,7 +3161,8 @@ "readOnly": true, "items": { "$ref": "./network.json#/definitions/SubResource" - } + }, + "description": "List of references to P2SVpnGateways." }, "etag": { "type": "string", @@ -3166,7 +3175,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/P2SVpnServerConfigurationProperties" + "$ref": "#/definitions/P2SVpnServerConfigurationProperties", + "description": "Properties of the P2SVpnServer configuration." }, "name": { "type": "string", @@ -3268,7 +3278,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/P2SVpnGatewayProperties" + "$ref": "#/definitions/P2SVpnGatewayProperties", + "description": "Properties of the P2SVpnGateway." }, "etag": { "type": "string", From 8558158c372f9fa2e692459e50330d99efe8dc0f Mon Sep 17 00:00:00 2001 From: Anton Evseev Date: Wed, 27 Mar 2019 15:07:23 +0300 Subject: [PATCH 2/2] Add missing x-ms-enum --- .../stable/2019-02-01/loadBalancer.json | 14 +++++++++----- .../stable/2019-02-01/publicIpAddress.json | 8 ++++++-- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json index f61805912508..3c6e49d24372 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/loadBalancer.json @@ -1539,13 +1539,17 @@ "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." }, "protocol": { - "type": "string", - "description": "Protocol - TCP, UDP or All", - "enum": [ + "type": "string", + "description": "The protocol for the outbound rule in load balancer. Possible values are: 'Tcp', 'Udp', and 'All'.", + "enum": [ "Tcp", - "Udp", + "Udp", "All" - ] + ], + "x-ms-enum": { + "name": "LoadBalancerOutboundRuleProtocol", + "modelAsString": true + } }, "enableTcpReset": { "type": "boolean", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpAddress.json index 14960bdee4f0..2c67f263957d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpAddress.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/publicIpAddress.json @@ -460,7 +460,7 @@ "properties": { "ddosCustomPolicy": { "readOnly": false, - "$ref":"./network.json#/definitions/SubResource", + "$ref":"./network.json#/definitions/SubResource", "description": "The DDoS custom policy associated with the public IP." }, "protectionCoverage": { @@ -468,8 +468,12 @@ "type": "string", "enum": [ "Basic", - "Standard" + "Standard" ], + "x-ms-enum": { + "name": "DdosSettingsProtectionCoverage", + "modelAsString": true + }, "description": "The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized." } },