Adding swagger updates to support the new NRP resource "DSCP Configuration" #9954
There are no files selected for viewing
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 |
|---|---|---|
|
|
@@ -1793,3 +1793,6 @@ azureADMetrics | |
| sparkr | ||
| ambari | ||
| dotnetspark | ||
| dscp | ||
| Dscp | ||
| qos | ||
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,343 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "NetworkManagementClient", | ||
| "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", | ||
| "version": "2020-06-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": { | ||
|
There was a problem hiding this comment.
Is this going to be a tracked or proxy resource? If tracked you will also need to support these list calls:
If proxy, you will need at least this list call:
There was a problem hiding this comment. This is going to be a tracked resource. Adding the pending calls and examples accordingly |
||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfiguration/{dscpConfigurationName}": { | ||
|
There was a problem hiding this comment.
ARM resource type names should be plural. Can you rename to There was a problem hiding this comment. Refactor accordingly #Resolved |
||
| "put": { | ||
| "tags": [ | ||
| "DscpConfiguration" | ||
| ], | ||
| "operationId": "DscpConfiguration_CreateOrUpdate", | ||
| "description": "Creates or updates a DSCP Configuration.", | ||
| "parameters": [ | ||
| { | ||
| "name": "resourceGroupName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource group." | ||
| }, | ||
| { | ||
| "name": "dscpConfigurationName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource." | ||
| }, | ||
| { | ||
| "name": "parameters", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/DscpConfiguration" | ||
| }, | ||
| "description": "Parameters supplied to the create or update dscp configuration operation." | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "201": { | ||
| "description": "Create successful. The operation returns the resulting DscpConfiguration resource.", | ||
| "schema": { | ||
| "$ref": "#/definitions/DscpConfiguration" | ||
| } | ||
| }, | ||
| "200": { | ||
| "description": "Update successful. The operation returns the resulting DscpConfiguration resource.", | ||
| "schema": { | ||
| "$ref": "#/definitions/DscpConfiguration" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "./network.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Create DSCP Configuration": { | ||
| "$ref": "./examples/DscpConfigurationCreate.json" | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true, | ||
| "x-ms-long-running-operation-options": { | ||
| "final-state-via": "location" | ||
| } | ||
| }, | ||
| "delete": { | ||
| "tags": [ | ||
| "DscpConfiguration" | ||
| ], | ||
| "operationId": "DscpConfiguration_Delete", | ||
| "description": "Deletes a DSCP Configuration.", | ||
| "parameters": [ | ||
| { | ||
| "name": "resourceGroupName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource group." | ||
| }, | ||
| { | ||
| "name": "dscpConfigurationName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource." | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "204": { | ||
| "description": "Request successful. Resource does not exist." | ||
| }, | ||
| "202": { | ||
| "description": "Accepted and the operation will complete asynchronously." | ||
| }, | ||
| "200": { | ||
| "description": "Delete successful." | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "./network.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Delete DSCP Configuration": { | ||
| "$ref": "./examples/DscpConfigurationDelete.json" | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true, | ||
| "x-ms-long-running-operation-options": { | ||
| "final-state-via": "location" | ||
| } | ||
| }, | ||
| "get": { | ||
| "tags": [ | ||
| "DscpConfiguration" | ||
| ], | ||
| "operationId": "DscpConfiguration_Get", | ||
| "description": "Gets a DSCP Configuration.", | ||
| "parameters": [ | ||
| { | ||
| "name": "resourceGroupName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource group." | ||
| }, | ||
| { | ||
| "name": "dscpConfigurationName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource." | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "./network.json#/parameters/SubscriptionIdParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Request successful. The operation returns the resulting DSCP Configuration resource.", | ||
| "schema": { | ||
| "$ref": "#/definitions/DscpConfiguration" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "./network.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Get Dscp Configuration": { | ||
| "$ref": "./examples/DscpConfigurationGet.json" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "DscpConfiguration": { | ||
| "properties": { | ||
| "properties": { | ||
| "x-ms-client-flatten": true, | ||
| "$ref": "#/definitions/DscpConfigurationPropertiesFormat", | ||
| "description": "Properties of the network interface." | ||
| }, | ||
| "etag": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "A unique read-only string that changes whenever the resource is updated." | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "./network.json#/definitions/Resource" | ||
| } | ||
| ], | ||
| "description": "DSCP Configuration in a resource group." | ||
| }, | ||
| "DscpConfigurationPropertiesFormat": { | ||
| "properties": { | ||
| "markings": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "integer", | ||
| "format": "int32" | ||
| }, | ||
| "description": "List of markings to be used in the configuration." | ||
| }, | ||
| "sourceIpRanges": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/QosIpRange" | ||
| }, | ||
| "description": "Source IP ranges." | ||
| }, | ||
| "destinationIpRanges": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/QosIpRange" | ||
| }, | ||
| "description": "Destination IP ranges." | ||
| }, | ||
| "sourcePortRanges": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/QosPortRange" | ||
| }, | ||
| "description": "Sources port ranges." | ||
| }, | ||
| "destinationPortRanges": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/QosPortRange" | ||
| }, | ||
| "description": "Destination port ranges." | ||
| }, | ||
| "protocol": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "DoNotUse", | ||
| "Icmp", | ||
| "Tcp", | ||
| "Udp", | ||
| "Gre", | ||
| "Esp", | ||
| "Ah", | ||
| "Vxlan", | ||
| "All" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "ProtocolType", | ||
| "modelAsString": true | ||
| }, | ||
| "description": "RNM supported protocol types." | ||
| }, | ||
| "qosCollectionId": { | ||
| "type": "string", | ||
| "readOnly": true, | ||
| "description": "Qos Collection ID generated by RNM." | ||
| }, | ||
| "associatedNetworkInterfaces": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "./networkInterface.json#/definitions/NetworkInterface" | ||
| }, | ||
| "readOnly": true, | ||
| "description": "Associated Network Interfaces to the DSCP Configuration." | ||
| }, | ||
| "resourceGuid": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "The resource GUID property of the DSCP Configuration resource." | ||
| }, | ||
| "provisioningState": { | ||
| "readOnly": true, | ||
| "$ref": "./network.json#/definitions/ProvisioningState", | ||
| "description": "The provisioning state of the DSCP Configuration resource." | ||
| } | ||
| }, | ||
| "description": "DSCP Configuration properties." | ||
| }, | ||
| "QosIpRange": { | ||
| "properties": { | ||
| "startIP": { | ||
| "type": "string", | ||
| "description": "Start IP Address." | ||
| }, | ||
| "endIP": { | ||
| "type": "string", | ||
| "description": "End IP Address." | ||
| } | ||
| }, | ||
| "description": "Qos Traffic Profiler IP Range properties." | ||
| }, | ||
| "QosPortRange": { | ||
| "properties": { | ||
| "start": { | ||
| "type": "integer", | ||
| "format": "int32", | ||
| "description": "Qos Port Range start." | ||
| }, | ||
| "end": { | ||
| "type": "integer", | ||
| "format": "int32", | ||
| "description": "Qos Port Range end." | ||
| } | ||
| }, | ||
| "description": "Qos Traffic Profiler Port range properties." | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Has the
2020-06-01been released to customers?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By the end of this month it should be supported, as far as I'm aware. Did notice yesterday while doing a little bit of support that NRP is already supporting in production this version.