diff --git a/.azure-pipelines-preproduction/package-lock.json b/.azure-pipelines-preproduction/package-lock.json index 741489043b83..76413cbb70d4 100644 --- a/.azure-pipelines-preproduction/package-lock.json +++ b/.azure-pipelines-preproduction/package-lock.json @@ -5,9 +5,9 @@ "requires": true, "dependencies": { "@azure/avocado": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.6.1.tgz", - "integrity": "sha512-GOdVNS/yr7wSQVUGfvR4/nP6+UDBrxqT/McvTsKuy1vWV8BwgKx3JZLB/9mrWYhXQZ257AQkVO9nepxRu9/PsQ==", + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.6.2.tgz", + "integrity": "sha512-DU4TD/+U0aXLjz4bGW+vxst4tXm3/HPiOrNh1BcY00rHRnRbR+ZY7AL/nA4+1P6LVPu8msLUXp6HTqqe4QrbHg==", "dev": true, "requires": { "@azure/openapi-markdown": "^0.9.1", @@ -88,9 +88,9 @@ } }, "@azure/rest-api-specs-scripts": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.5.1.tgz", - "integrity": "sha512-Nwi4jsHMVG1Pd3hJAh5D8JxTlx6PaDpYNfDrQSG3QAvVwE5n+MK9SmHL47akDfhKJQibuPompKwgw55Gy23Reg==", + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.5.7.tgz", + "integrity": "sha512-KbhwZzENz5pB9Me9PxhhuqL7Lru8bmpSOWQ291buvxEYQ+ZwzvHyA0cA8yL5raXZX2IJhslc7ThtcPhAqC0hFw==", "dev": true, "requires": { "@azure/avocado": "^0.4.1", @@ -100,7 +100,7 @@ "fs-extra": "^7.0.1", "glob": "^7.1.3", "js-yaml": "^3.13.1", - "oav": "^0.19.6", + "oav": "0.19.6", "request": "^2.88.0" }, "dependencies": { @@ -151,23 +151,25 @@ "dev": true }, "@octokit/endpoint": { - "version": "5.3.5", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.3.5.tgz", - "integrity": "sha512-f8KqzIrnzPLiezDsZZPB+K8v8YSv6aKFl7eOu59O46lmlW4HagWl1U6NWl6LmT8d1w7NsKBI3paVtzcnRGO1gw==", + "version": "5.5.1", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", + "integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", "dev": true, "requires": { + "@octokit/types": "^2.0.0", "is-plain-object": "^3.0.0", "universal-user-agent": "^4.0.0" } }, "@octokit/request": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.1.0.tgz", - "integrity": "sha512-I15T9PwjFs4tbWyhtFU2Kq7WDPidYMvRB7spmxoQRZfxSmiqullG+Nz+KbSmpkfnlvHwTr1e31R5WReFRKMXjg==", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.3.1.tgz", + "integrity": "sha512-5/X0AL1ZgoU32fAepTfEoggFinO3rxsMLtzhlUX+RctLrusn/CApJuGFCd0v7GMFhF+8UiCsTTfsu7Fh1HnEJg==", "dev": true, "requires": { - "@octokit/endpoint": "^5.1.0", + "@octokit/endpoint": "^5.5.0", "@octokit/request-error": "^1.0.1", + "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "is-plain-object": "^3.0.0", "node-fetch": "^2.3.0", @@ -176,22 +178,23 @@ } }, "@octokit/request-error": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.0.4.tgz", - "integrity": "sha512-L4JaJDXn8SGT+5G0uX79rZLv0MNJmfGa4vb4vy1NnpjSnWDLJRy6m90udGwvMmavwsStgbv2QNkPzzTCMmL+ig==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.2.0.tgz", + "integrity": "sha512-DNBhROBYjjV/I9n7A8kVkmQNkqFAMem90dSxqvPq57e2hBr7mNTX98y3R2zDpqMQHVRpBDjsvsfIGgBzy+4PAg==", "dev": true, "requires": { + "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" } }, "@octokit/rest": { - "version": "16.28.9", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.28.9.tgz", - "integrity": "sha512-IKGnX+Tvzt7XHhs8f4ajqxyJvYAMNX5nWfoJm4CQj8LZToMiaJgutf5KxxpxoC3y5w7JTJpW5rnWnF4TsIvCLA==", + "version": "16.35.0", + "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.35.0.tgz", + "integrity": "sha512-9ShFqYWo0CLoGYhA1FdtdykJuMzS/9H6vSbbQWDX4pWr4p9v+15MsH/wpd/3fIU+tSxylaNO48+PIHqOkBRx3w==", "dev": true, "requires": { - "@octokit/request": "^5.0.0", + "@octokit/request": "^5.2.0", "@octokit/request-error": "^1.0.2", "atob-lite": "^2.0.0", "before-after-hook": "^2.0.0", @@ -205,6 +208,15 @@ "universal-user-agent": "^4.0.0" } }, + "@octokit/types": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.0.1.tgz", + "integrity": "sha512-YDYgV6nCzdGdOm7wy43Ce8SQ3M5DMKegB8E5sTB/1xrxOdo2yS/KgUgML2N2ZGD621mkbdrAglwTyA4NDOlFFA==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + }, "@ts-common/add-position": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/@ts-common/add-position/-/add-position-0.0.2.tgz", @@ -389,20 +401,26 @@ "dev": true }, "@types/node": { - "version": "10.14.16", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.14.16.tgz", - "integrity": "sha512-/opXIbfn0P+VLt+N8DE4l8Mn8rbhiJgabU96ZJ0p9mxOkIks5gh6RUnpHak7Yh0SFkyjO/ODbxsQQPV2bpMmyA==", + "version": "10.17.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.5.tgz", + "integrity": "sha512-RElZIr/7JreF1eY6oD5RF3kpmdcreuQPjg5ri4oQ5g9sq7YWU8HkfB3eH8GwAwxf5OaCh0VPi7r4N/yoTGelrA==", "dev": true }, "@types/node-fetch": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.0.tgz", - "integrity": "sha512-TLFRywthBgL68auWj+ziWu+vnmmcHCDFC/sqCOQf1xTz4hRq8cu79z8CtHU9lncExGBsB8fXA4TiLDLt6xvMzw==", + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.3.tgz", + "integrity": "sha512-X3TNlzZ7SuSwZsMkb5fV7GrPbVKvHc2iwHmslb8bIxRKWg2iqkfm3F/Wd79RhDpOXR7wCtKAwc5Y2JE6n/ibyw==", "dev": true, "requires": { "@types/node": "*" } }, + "@types/prettier": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-1.18.3.tgz", + "integrity": "sha512-48rnerQdcZ26odp+HOvDGX8IcUkYOCuMc2BodWYTe956MqkHlOGAG4oFQ83cjZ0a4GAgj7mb4GUClxYd2Hlodg==", + "dev": true + }, "@types/retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", @@ -410,9 +428,9 @@ "dev": true }, "abab": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.1.tgz", - "integrity": "sha512-1zSbbCuoIjafKZ3mblY5ikvAb0ODUbqBnFuUb7f6uLeQhhGJ0vEV4ntmtxKLT2WgXCO94E07BjunsIw1jOMPZw==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.2.tgz", + "integrity": "sha512-2scffjvioEmNz0OyDSLGWDfKCVwaKc6l9Pm9kOIREU13ClXZvHpg/nRL5xyjSSSLhOnXqft2HpsAzNEEA8cFFg==", "dev": true }, "abbrev": { @@ -428,9 +446,9 @@ "dev": true }, "acorn-globals": { - "version": "4.3.3", - "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-4.3.3.tgz", - "integrity": "sha512-vkR40VwS2SYO98AIeFvzWWh+xyc2qi9s7OoXSFEGIP/rOJKzjnhykaZJNnHdoq4BL2gGxI5EZOU16z896EYnOQ==", + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-4.3.4.tgz", + "integrity": "sha512-clfQEh21R+D0leSbUdWf3OcfqyaCSAQ8Ryq00bofSekfr9W8u1jyYZo6ir0xu9Gtcf7BjcHJpnbZH7JOCpP60A==", "dev": true, "requires": { "acorn": "^6.0.1", @@ -612,9 +630,9 @@ "dev": true }, "autorest": { - "version": "2.0.4283", - "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4283.tgz", - "integrity": "sha512-3jU9yDR71d2thRnKdPH03DaWbla1Iqnrx2rqUUwbMrb4di36a8+nttCQaTWG7biWPJc6Ke6zSSTzFH0uhya+Nw==", + "version": "2.0.4407", + "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4407.tgz", + "integrity": "sha512-keyeMDb/bVNN8hnDd8o08UC2C1OE8HRhubxksljSvKM5osHIJnoKBA1k3kD7MPAJ/+m6UjDQXci3ronxZeYy+Q==", "dev": true }, "aws-sign2": { @@ -1039,9 +1057,9 @@ "dev": true }, "core-js": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.9.tgz", - "integrity": "sha512-HOpZf6eXmnl7la+cUdMnLvUxKNqLUzJvgIziQ0DiF3JwSImNphIqdGqzj6hIKyX04MmV0poclQ7+wjWvxQyR2A==", + "version": "2.6.10", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.10.tgz", + "integrity": "sha512-I39t74+4t+zau64EN1fE5v2W31Adtc/REhzWN+gWRRXg6WH5qAsZm62DHpQ1+Yhe4047T55jvzz7MUqF/dBBlA==", "dev": true }, "core-util-is": { @@ -1070,27 +1088,27 @@ "dev": true }, "cspell": { - "version": "4.0.28", - "resolved": "https://registry.npmjs.org/cspell/-/cspell-4.0.28.tgz", - "integrity": "sha512-2YH8pOUnaGCjHHKKUC2K247nAKx2/ah/JsyMYgSe0U3R1Lokl6+HwTsU2+I01o8u5GbM5sLjxsQRPzceYQkzLg==", + "version": "4.0.33", + "resolved": "https://registry.npmjs.org/cspell/-/cspell-4.0.33.tgz", + "integrity": "sha512-jFtXC+08Awb24qlnNId6YSvend7gOJPR4PmbeGySuBxQTrRtds8aoyGDpYgSChLp083UNYq+Ox9WCiAB7CWkcQ==", "dev": true, "requires": { "chalk": "^2.4.2", - "commander": "^2.20.0", + "commander": "^2.20.3", "comment-json": "^1.1.3", - "cspell-glob": "^0.1.11", - "cspell-lib": "^4.0.25", + "cspell-glob": "^0.1.12", + "cspell-lib": "^4.1.3", "fs-extra": "^8.1.0", "gensequence": "^2.1.2", "get-stdin": "^7.0.0", - "glob": "^7.1.4", + "glob": "^7.1.5", "minimatch": "^3.0.4" }, "dependencies": { "commander": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", - "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==", + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", "dev": true }, "fs-extra": { @@ -1107,9 +1125,9 @@ } }, "cspell-dict-companies": { - "version": "1.0.14", - "resolved": "https://registry.npmjs.org/cspell-dict-companies/-/cspell-dict-companies-1.0.14.tgz", - "integrity": "sha512-q4Xfe/vNteOs57r+YeEYzVsoQe2YGsi3uVMv06w0CkMa9y8llDXpBv7UJniLZVyW19491jlxIORkHx4i39MBUw==", + "version": "1.0.16", + "resolved": "https://registry.npmjs.org/cspell-dict-companies/-/cspell-dict-companies-1.0.16.tgz", + "integrity": "sha512-w2kXucNmDxZl3809CHfEPLs+XS/Zigi3bZW82d6WttCe6ts/GyQAQC2KiYG1VHjis8esXiMXkbxQEEL0yOZNJw==", "dev": true, "requires": { "configstore": "^5.0.0" @@ -1133,37 +1151,133 @@ "configstore": "^5.0.0" } }, + "cspell-dict-dotnet": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/cspell-dict-dotnet/-/cspell-dict-dotnet-1.0.12.tgz", + "integrity": "sha512-9o3Vppohi00tafLaS9z3FR2qg8MjwAiJ1sQeCwylvAWDmgs/lUbBLLFkgeQ0JYgMj3s5GG1xRP/QWmKMMBXt+w==", + "dev": true, + "requires": { + "configstore": "^5.0.0" + } + }, "cspell-dict-elixir": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/cspell-dict-elixir/-/cspell-dict-elixir-1.0.10.tgz", - "integrity": "sha512-Z+9K1ZHGo5XnbS2AZ5DG2bpEA9wJ4BdsTa69VIqPgZ6vEfVLqeMidk70FF0Y/DY49+Qyg3ngY0WyE5Je/Romzw==", + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/cspell-dict-elixir/-/cspell-dict-elixir-1.0.11.tgz", + "integrity": "sha512-re02+p1cowsQRqBH6zjLo9YcOwJBQ2JsbdM77w5GskvcSK4q5I4yrwtb1DlkU8w6yWGmsUO0CBfbyrkbfQ2X+Q==", "dev": true, "requires": { "configstore": "^5.0.0" } }, "cspell-dict-en-gb": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/cspell-dict-en-gb/-/cspell-dict-en-gb-1.1.11.tgz", - "integrity": "sha512-UnmAeMDzf/YeXuI85BIaQzpArXlt+m+I9S9uy88nvUfq6goOfUFN8Axh0idDtqsFNoaMS5TgSzvjP7DgMXArYg==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/cspell-dict-en-gb/-/cspell-dict-en-gb-1.1.13.tgz", + "integrity": "sha512-af3QfXtKbG1aMfUIHsnX8RCCY1/gkSNR7/u62lfl/O6zfbTLZZR8qZ1ezs4suVVoM5l4iAoUGvdO6KyEc+1kNA==", "dev": true, "requires": { "configstore": "^5.0.0" } }, "cspell-dict-en_us": { - "version": "1.2.18", - "resolved": "https://registry.npmjs.org/cspell-dict-en_us/-/cspell-dict-en_us-1.2.18.tgz", - "integrity": "sha512-P2TRblBVd9KOfwjvI5mxzEXMGBvvTIfqcKSQ+0RbpwC2S4ImW9k++LYxy9LtfSRmdSGjHbejYYtsrgvId1KcoA==", + "version": "1.2.20", + "resolved": "https://registry.npmjs.org/cspell-dict-en_us/-/cspell-dict-en_us-1.2.20.tgz", + "integrity": "sha512-LIK9Q/p6Ki7/BETZobLpkcCci/1GIN5de6ptVAWLOlzdtAlaEgomYa6fQ+ne4WNvZL+66fxPgxBTVfW/jFqqUw==", "dev": true, "requires": { "configstore": "^5.0.0" } }, + "cspell-dict-fonts": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/cspell-dict-fonts/-/cspell-dict-fonts-1.0.3.tgz", + "integrity": "sha512-0iDY0S1qd+D0m8p7209XTbWzTMQqvknJ5GjWfucYV7mSIlU6Ic5e2yY1cr8O7CSiRKLFQTJ/77yTuIZK+69rDA==", + "dev": true, + "requires": { + "configstore": "^4.0.0" + }, + "dependencies": { + "configstore": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-4.0.0.tgz", + "integrity": "sha512-CmquAXFBocrzaSM8mtGPMM/HiWmyIpr4CcJl/rgY2uCObZ/S7cKU0silxslqJejl+t/T9HS8E0PUNQD81JGUEQ==", + "dev": true, + "requires": { + "dot-prop": "^4.1.0", + "graceful-fs": "^4.1.2", + "make-dir": "^1.0.0", + "unique-string": "^1.0.0", + "write-file-atomic": "^2.0.0", + "xdg-basedir": "^3.0.0" + } + }, + "crypto-random-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-1.0.0.tgz", + "integrity": "sha1-ojD2T1aDEOFJgAmUB5DsmVRbyn4=", + "dev": true + }, + "dot-prop": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-4.2.0.tgz", + "integrity": "sha512-tUMXrxlExSW6U2EXiiKGSBVdYgtV8qlHL+C10TsW4PURY/ic+eaysnSkwB4kA/mBlCyy/IKDJ+Lc3wbWeaXtuQ==", + "dev": true, + "requires": { + "is-obj": "^1.0.0" + } + }, + "is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=", + "dev": true + }, + "make-dir": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz", + "integrity": "sha512-2w31R7SJtieJJnQtGc7RVL2StM2vGYVfqUOvUDxH6bC6aJTxPxTF0GnIgCyu7tjockiUWAYQRbxa7vKn34s5sQ==", + "dev": true, + "requires": { + "pify": "^3.0.0" + } + }, + "pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", + "dev": true + }, + "unique-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-1.0.0.tgz", + "integrity": "sha1-nhBXzKhRq7kzmPizOuGHuZyuwRo=", + "dev": true, + "requires": { + "crypto-random-string": "^1.0.0" + } + }, + "write-file-atomic": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.3.tgz", + "integrity": "sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.11", + "imurmurhash": "^0.1.4", + "signal-exit": "^3.0.2" + } + }, + "xdg-basedir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-3.0.0.tgz", + "integrity": "sha1-SWsswQnsqNus/i3HK2A8F8WHCtQ=", + "dev": true + } + } + }, "cspell-dict-fullstack": { - "version": "1.0.17", - "resolved": "https://registry.npmjs.org/cspell-dict-fullstack/-/cspell-dict-fullstack-1.0.17.tgz", - "integrity": "sha512-XmFyvt5r9JXcIjnycFfZfc/82dmMBUSowL4Oa/Mubx0Tm66bKOTmhrDatXl96qo6J0cIoyoPXitsfj5YaDV17g==", + "version": "1.0.18", + "resolved": "https://registry.npmjs.org/cspell-dict-fullstack/-/cspell-dict-fullstack-1.0.18.tgz", + "integrity": "sha512-vEVf+ppML1PP9vdfkXnydABIYNyDORVN28sniBo0ILLhqFjCJvs1SNQuZxWhak5sgSZ9z4xiHU9TqCEUqhf1jw==", "dev": true, "requires": { "configstore": "^5.0.0" @@ -1233,18 +1347,18 @@ } }, "cspell-dict-powershell": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/cspell-dict-powershell/-/cspell-dict-powershell-1.0.2.tgz", - "integrity": "sha512-BW2Bdpet0yRQKB+7HjA75O0aJnh1VjdnMLNYb1SLvow73uCsC8GpvYLtvFyDm0Q717FYKoPzuZiSrXhyHerNAw==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/cspell-dict-powershell/-/cspell-dict-powershell-1.0.3.tgz", + "integrity": "sha512-YHVe8NkjtZmBvdclXev7dkoTODxweiq8H/Z8N0H5jc8pW1IJGBIXIFxlk1AjRW3bS19D5OZIx13J8ims6i5s8w==", "dev": true, "requires": { "configstore": "^5.0.0" } }, "cspell-dict-python": { - "version": "1.0.14", - "resolved": "https://registry.npmjs.org/cspell-dict-python/-/cspell-dict-python-1.0.14.tgz", - "integrity": "sha512-w8kevjvayndKkZqY4yt877UzGXUNTG6gB0zoeOCVxnAFFqTexVvmJ9Johc+eOdqd+dnUu6gF8XfX4ZdX5J+Rxw==", + "version": "1.0.17", + "resolved": "https://registry.npmjs.org/cspell-dict-python/-/cspell-dict-python-1.0.17.tgz", + "integrity": "sha512-E1zzL2nyoHJ4oLriGqqFjoCmYs9nBeqnn/3WOdmBILaahWV5Ms61iEGqJNt2ggRTKFuAq7ZZDfoUmK2yYwvgEA==", "dev": true, "requires": { "configstore": "^5.0.0" @@ -1268,10 +1382,184 @@ "configstore": "^5.0.0" } }, + "cspell-dict-software-terms": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/cspell-dict-software-terms/-/cspell-dict-software-terms-1.0.3.tgz", + "integrity": "sha512-vY0uAo+93JlggPQJ5BiqSAeSOdLSTCtXFGSTR2kmO0slOzjY+fs6iKxKZbCc0l3wdfDzlxS2U4Hf9K+ChW893g==", + "dev": true, + "requires": { + "configstore": "^4.0.0" + }, + "dependencies": { + "configstore": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-4.0.0.tgz", + "integrity": "sha512-CmquAXFBocrzaSM8mtGPMM/HiWmyIpr4CcJl/rgY2uCObZ/S7cKU0silxslqJejl+t/T9HS8E0PUNQD81JGUEQ==", + "dev": true, + "requires": { + "dot-prop": "^4.1.0", + "graceful-fs": "^4.1.2", + "make-dir": "^1.0.0", + "unique-string": "^1.0.0", + "write-file-atomic": "^2.0.0", + "xdg-basedir": "^3.0.0" + } + }, + "crypto-random-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-1.0.0.tgz", + "integrity": "sha1-ojD2T1aDEOFJgAmUB5DsmVRbyn4=", + "dev": true + }, + "dot-prop": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-4.2.0.tgz", + "integrity": "sha512-tUMXrxlExSW6U2EXiiKGSBVdYgtV8qlHL+C10TsW4PURY/ic+eaysnSkwB4kA/mBlCyy/IKDJ+Lc3wbWeaXtuQ==", + "dev": true, + "requires": { + "is-obj": "^1.0.0" + } + }, + "is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=", + "dev": true + }, + "make-dir": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz", + "integrity": "sha512-2w31R7SJtieJJnQtGc7RVL2StM2vGYVfqUOvUDxH6bC6aJTxPxTF0GnIgCyu7tjockiUWAYQRbxa7vKn34s5sQ==", + "dev": true, + "requires": { + "pify": "^3.0.0" + } + }, + "pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", + "dev": true + }, + "unique-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-1.0.0.tgz", + "integrity": "sha1-nhBXzKhRq7kzmPizOuGHuZyuwRo=", + "dev": true, + "requires": { + "crypto-random-string": "^1.0.0" + } + }, + "write-file-atomic": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.3.tgz", + "integrity": "sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.11", + "imurmurhash": "^0.1.4", + "signal-exit": "^3.0.2" + } + }, + "xdg-basedir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-3.0.0.tgz", + "integrity": "sha1-SWsswQnsqNus/i3HK2A8F8WHCtQ=", + "dev": true + } + } + }, + "cspell-dict-typescript": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/cspell-dict-typescript/-/cspell-dict-typescript-1.0.1.tgz", + "integrity": "sha512-ihyMstWPKhBHGIX+gG/blh4zq740eIOBzg4B0qoOi+ox9EaipZO7nA45Fj3StY9rw//vWXpgr30K9My5n0GucA==", + "dev": true, + "requires": { + "configstore": "^4.0.0" + }, + "dependencies": { + "configstore": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-4.0.0.tgz", + "integrity": "sha512-CmquAXFBocrzaSM8mtGPMM/HiWmyIpr4CcJl/rgY2uCObZ/S7cKU0silxslqJejl+t/T9HS8E0PUNQD81JGUEQ==", + "dev": true, + "requires": { + "dot-prop": "^4.1.0", + "graceful-fs": "^4.1.2", + "make-dir": "^1.0.0", + "unique-string": "^1.0.0", + "write-file-atomic": "^2.0.0", + "xdg-basedir": "^3.0.0" + } + }, + "crypto-random-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-1.0.0.tgz", + "integrity": "sha1-ojD2T1aDEOFJgAmUB5DsmVRbyn4=", + "dev": true + }, + "dot-prop": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-4.2.0.tgz", + "integrity": "sha512-tUMXrxlExSW6U2EXiiKGSBVdYgtV8qlHL+C10TsW4PURY/ic+eaysnSkwB4kA/mBlCyy/IKDJ+Lc3wbWeaXtuQ==", + "dev": true, + "requires": { + "is-obj": "^1.0.0" + } + }, + "is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=", + "dev": true + }, + "make-dir": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz", + "integrity": "sha512-2w31R7SJtieJJnQtGc7RVL2StM2vGYVfqUOvUDxH6bC6aJTxPxTF0GnIgCyu7tjockiUWAYQRbxa7vKn34s5sQ==", + "dev": true, + "requires": { + "pify": "^3.0.0" + } + }, + "pify": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", + "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", + "dev": true + }, + "unique-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-1.0.0.tgz", + "integrity": "sha1-nhBXzKhRq7kzmPizOuGHuZyuwRo=", + "dev": true, + "requires": { + "crypto-random-string": "^1.0.0" + } + }, + "write-file-atomic": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.3.tgz", + "integrity": "sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.11", + "imurmurhash": "^0.1.4", + "signal-exit": "^3.0.2" + } + }, + "xdg-basedir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-3.0.0.tgz", + "integrity": "sha1-SWsswQnsqNus/i3HK2A8F8WHCtQ=", + "dev": true + } + } + }, "cspell-glob": { - "version": "0.1.11", - "resolved": "https://registry.npmjs.org/cspell-glob/-/cspell-glob-0.1.11.tgz", - "integrity": "sha512-1s9539g+AB+V0gX4TPfCvhwWYso/fKlWQIX5w31BuqLjV6e8542x9vpdO/GS7aq1y1vec4ocx0B9I/d1SGFDSg==", + "version": "0.1.12", + "resolved": "https://registry.npmjs.org/cspell-glob/-/cspell-glob-0.1.12.tgz", + "integrity": "sha512-4ogphDPvCAZtFuBBcRZNf8GTmyuWHJ/PN3oH39AnIgjejMN2P0DsWXw0bSDilbbldR2iABWGVwTlLayxXCxTbQ==", "dev": true, "requires": { "micromatch": "^4.0.2" @@ -1323,9 +1611,9 @@ } }, "cspell-io": { - "version": "4.0.17", - "resolved": "https://registry.npmjs.org/cspell-io/-/cspell-io-4.0.17.tgz", - "integrity": "sha512-srJnvfTm9QdrAGPx7OIR6MIZeXJPgwWupderhy4ywDQKgds4Yj1w3f10JWzHgsfWAwExAaEs3GZ4fEMUeWhnAA==", + "version": "4.0.19", + "resolved": "https://registry.npmjs.org/cspell-io/-/cspell-io-4.0.19.tgz", + "integrity": "sha512-ZDIDDNWtvGi0bCNE8v5Q6pD49raCFxGZkfAsWjs8Q+4FT1X1BiyjNlvEO1csPTxhC9o+MlCkhdpxEnv+QZZCBQ==", "dev": true, "requires": { "iconv-lite": "^0.4.24", @@ -1333,20 +1621,22 @@ } }, "cspell-lib": { - "version": "4.0.25", - "resolved": "https://registry.npmjs.org/cspell-lib/-/cspell-lib-4.0.25.tgz", - "integrity": "sha512-EltUo+BBx15gCCYuDQ2V/pSPu1xIje9mdzCaEDoTJXIl1J5QVONmc91sukXLNEoymG4cdoZlnd2xg4fV/orynQ==", + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/cspell-lib/-/cspell-lib-4.1.3.tgz", + "integrity": "sha512-mJqdo7rzITSifbqEamt6Ex3S7+xenmSb+Gf++PhRU9DSlC3z2YgcFxpJqzTAuf2FaIBtj3QY5q8Ipvi0gH6CXA==", "dev": true, "requires": { "comment-json": "^1.1.3", "configstore": "^5.0.0", - "cspell-dict-companies": "^1.0.12", - "cspell-dict-cpp": "^1.1.21", + "cspell-dict-companies": "^1.0.16", + "cspell-dict-cpp": "^1.1.23", "cspell-dict-django": "^1.0.12", - "cspell-dict-elixir": "^1.0.10", - "cspell-dict-en-gb": "^1.1.11", - "cspell-dict-en_us": "^1.2.18", - "cspell-dict-fullstack": "^1.0.15", + "cspell-dict-dotnet": "^1.0.12", + "cspell-dict-elixir": "^1.0.11", + "cspell-dict-en-gb": "^1.1.13", + "cspell-dict-en_us": "^1.2.20", + "cspell-dict-fonts": "^1.0.3", + "cspell-dict-fullstack": "^1.0.18", "cspell-dict-golang": "^1.1.12", "cspell-dict-haskell": "^1.0.2", "cspell-dict-html-symbol-entities": "^1.0.11", @@ -1354,16 +1644,18 @@ "cspell-dict-latex": "^1.0.11", "cspell-dict-lorem-ipsum": "^1.0.10", "cspell-dict-php": "^1.0.11", - "cspell-dict-powershell": "^1.0.2", - "cspell-dict-python": "^1.0.14", + "cspell-dict-powershell": "^1.0.3", + "cspell-dict-python": "^1.0.17", "cspell-dict-rust": "^1.0.10", "cspell-dict-scala": "^1.0.9", - "cspell-io": "^4.0.17", - "cspell-trie-lib": "^4.0.15", - "cspell-util-bundle": "^4.0.5", + "cspell-dict-software-terms": "^1.0.3", + "cspell-dict-typescript": "^1.0.1", + "cspell-io": "^4.0.19", + "cspell-trie-lib": "^4.1.1", + "cspell-util-bundle": "^4.0.6", "fs-extra": "^8.1.0", "gensequence": "^2.1.2", - "vscode-uri": "^2.0.3" + "vscode-uri": "^2.1.1" }, "dependencies": { "fs-extra": { @@ -1380,19 +1672,19 @@ } }, "cspell-trie-lib": { - "version": "4.0.15", - "resolved": "https://registry.npmjs.org/cspell-trie-lib/-/cspell-trie-lib-4.0.15.tgz", - "integrity": "sha512-k3P03msJJh6Fhic9db7kva3+VodhvywvxxB5Q8Y7qF1xCu9zL2Zeoi+gA8ziL1QtUFqAqpzbDNPfiHhz6BaJsQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/cspell-trie-lib/-/cspell-trie-lib-4.1.1.tgz", + "integrity": "sha512-lyKfiXCLyNYqcLiwwctzQjBV5ZTeeQDWRHC69Qrj16oTFjEGRgY2VkREzRRwy2fj0/D/Q3wQShq5sYTx9DBofg==", "dev": true, "requires": { - "gensequence": "^2.1.2", - "js-xxhash": "^1.0.1" + "gensequence": "^2.1.3", + "js-xxhash": "^1.0.4" } }, "cspell-util-bundle": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/cspell-util-bundle/-/cspell-util-bundle-4.0.5.tgz", - "integrity": "sha512-luu/xIjoTRt82eJJxf77fhgjU6XJve+CfoTyfejOj7niYDRvoZkt0rTSHPgTI6MADjaZxlCLleSihEgqidt5WQ==", + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/cspell-util-bundle/-/cspell-util-bundle-4.0.6.tgz", + "integrity": "sha512-EaKvZOr2vzgYeXvEAX9lXNuUU5fA8E+xsaluA0oOQ7lNsNEMmDEjTuyroPpdes7KNuJSCvZeHjmWHU0YlUly7w==", "dev": true }, "cssom": { @@ -1437,9 +1729,9 @@ }, "dependencies": { "whatwg-url": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.0.0.tgz", - "integrity": "sha512-37GeVSIJ3kn1JgKyjiYNmSLP1yzbpb29jdmwBSgkD9h40/hyrR/OifpVUndji3tmwGgD8qpw7iQu3RSbCrBpsQ==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", + "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", "dev": true, "requires": { "lodash.sortby": "^4.7.0", @@ -1580,9 +1872,9 @@ } }, "dot-prop": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.1.0.tgz", - "integrity": "sha512-n1oC6NBF+KM9oVXtjmen4Yo7HyAVWV2UUl50dCYJdw2924K6dX9bf9TTTWaKtYlRn0FEtxG27KS80ayVLixxJA==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.2.0.tgz", + "integrity": "sha512-uEUyaDKoSQ1M4Oq8l45hSE26SnTxL6snNnqvK/VWx5wJhmff5z0FUVJDKDanor/6w3kzE3i7XZOk+7wC0EXr1A==", "dev": true, "requires": { "is-obj": "^2.0.0" @@ -1626,9 +1918,9 @@ } }, "end-of-stream": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", - "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", "dev": true, "requires": { "once": "^1.4.0" @@ -1664,23 +1956,27 @@ } }, "es-abstract": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.13.0.tgz", - "integrity": "sha512-vDZfg/ykNxQVwup/8E1BZhVzFfBxs9NqMzGcvIJrqg5k2/5Za2bWo40dK2J1pgLngZ7c+Shh8lwYtLGyrwPutg==", + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.16.0.tgz", + "integrity": "sha512-xdQnfykZ9JMEiasTAJZJdMWCQ1Vm00NBw79/AWi7ELfZuuPCSOMDZbT9mkOfSctVtfhb+sAAzrm+j//GjjLHLg==", "dev": true, "requires": { "es-to-primitive": "^1.2.0", "function-bind": "^1.1.1", "has": "^1.0.3", + "has-symbols": "^1.0.0", "is-callable": "^1.1.4", "is-regex": "^1.0.4", - "object-keys": "^1.0.12" + "object-inspect": "^1.6.0", + "object-keys": "^1.1.1", + "string.prototype.trimleft": "^2.1.0", + "string.prototype.trimright": "^2.1.0" } }, "es-to-primitive": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.0.tgz", - "integrity": "sha512-qZryBOJjV//LaxLTV6UC//WewneB3LcXOL9NP++ozKVXsIIIpm/2c13UDiD9Jp2eThsecw9m3jPqDwTyobcdbg==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", "dev": true, "requires": { "is-callable": "^1.1.4", @@ -1963,9 +2259,9 @@ "dev": true }, "fast-safe-stringify": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.6.tgz", - "integrity": "sha512-q8BZ89jjc+mz08rSxROs8VsrBBcn1SIw1kq9NjolL509tkABRk9io01RAjSaEv1Xb2uFLt8VtRiZbGp5H8iDtg==", + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.7.tgz", + "integrity": "sha512-Utm6CdzT+6xsDk2m8S6uL8VHxNwI6Jub+e9NYTcAms28T84pTa25GJQV9j0CY0N1rM8hK4x6grpF2BQf+2qwVA==", "dev": true }, "fecha": { @@ -2016,9 +2312,9 @@ }, "dependencies": { "is-buffer": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.3.tgz", - "integrity": "sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==", + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.4.tgz", + "integrity": "sha512-Kq1rokWXOPXWuaMAqZiJW4XxsmD9zGx9q4aePabbn3qCRGedtH7Cm+zV8WETitMfu1wdh+Rvd6w5egwSngUX2A==", "dev": true } } @@ -2148,9 +2444,9 @@ } }, "glob": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.4.tgz", - "integrity": "sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A==", + "version": "7.1.6", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", + "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", "dev": true, "requires": { "fs.realpath": "^1.0.0", @@ -2205,9 +2501,9 @@ } }, "graceful-fs": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.2.tgz", - "integrity": "sha512-IItsdsea19BoLC7ELy13q1iJFNmd7ofZH5+X/pJr90/nRoPEX0DJo1dHDbgtYWOhJhcCgMDTOw84RZ72q6lB+Q==", + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.3.tgz", + "integrity": "sha512-a30VEBm4PEdx1dRB7MFK7BejejvCvBronbLjht+sHuGYj8PHs7M/5Z+rt5lw551vZ7yfTCj4Vuyy3mSJytDWRQ==", "dev": true }, "graphlib": { @@ -2226,9 +2522,9 @@ "dev": true }, "handlebars": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.2.0.tgz", - "integrity": "sha512-Kb4xn5Qh1cxAKvQnzNWZ512DhABzyFNmsaJf3OAkWNa4NkaqWcNI8Tao8Tasi0/F4JD9oyG0YxuFyvyR57d+Gw==", + "version": "4.5.1", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.1.tgz", + "integrity": "sha512-C29UoFzHe9yM61lOsIlCE5/mQVGrnIOrOq7maQl76L7tYPCgC1og0Ajt6uWnX4ZTxBPnjw+CUvawphwCfJgUnA==", "dev": true, "requires": { "neo-async": "^2.6.0", @@ -2329,9 +2625,9 @@ "dev": true }, "hosted-git-info": { - "version": "2.8.4", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.4.tgz", - "integrity": "sha512-pzXIvANXEFrc5oFFXRMkbLPQ2rXRoDERwDLyrcUxGhaZhgP54BBSl9Oheh7Vv0T090cszWBxPjkQQ5Sq1PbBRQ==", + "version": "2.8.5", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.5.tgz", + "integrity": "sha512-kssjab8CvdXfcXMXVcvsXum4Hwdq9XGtRD3TteMEvEbq0LXyiNQr6AprqKqfeaDXze7SxWvRxdpwE6ku7ikLkg==", "dev": true }, "html-encoding-sniffer": { @@ -2803,13 +3099,13 @@ "dev": true }, "json-schema-faker": { - "version": "0.5.0-rc17", - "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rc17.tgz", - "integrity": "sha512-ZQSLPpnsGiMBuPOHi09cAzhsiIeOcs5im2GAQ2P6XKyWOuetO8eYdYCP/kW7VVU891Ucan0/dl8GYbRA6pf9gw==", + "version": "0.5.0-rc23", + "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rc23.tgz", + "integrity": "sha512-lRzFEnp55TihRzMvUBrtvTlM/aHGhCwfes0/T9bN9OiB2n36/SUFxtMn7anYoES+f95eU3viJ/foXKosCwsiJw==", "dev": true, "requires": { - "json-schema-ref-parser": "^6.0.2", - "jsonpath": "^1.0.1", + "json-schema-ref-parser": "^6.1.0", + "jsonpath-plus": "^1.0.0", "randexp": "^0.5.3" } }, @@ -2864,6 +3160,12 @@ } } }, + "jsonpath-plus": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-1.1.0.tgz", + "integrity": "sha512-ydqTBOuLcFCUr9e7AxJlKCFgxzEQ03HjnIim0hJSdk2NxD8MOsaMOrRgP6XWEm5q3VuDY5+cRT1DM9vLlGo/qA==", + "dev": true + }, "jsonschema": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/jsonschema/-/jsonschema-1.2.4.tgz", @@ -2929,9 +3231,9 @@ } }, "linq": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/linq/-/linq-3.2.0.tgz", - "integrity": "sha512-rdmaLOf2tSCzZ75scdjjN/LVHGZzRu48ql9LdxppQec/pKpPtf8jlMDlPBX3rQnLMcGPtAx8Lel6YbF7jND70g==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/linq/-/linq-3.2.1.tgz", + "integrity": "sha512-BEhjQpbvrKPWlg5m/+PXTHsQoXzzR0UWCvgI8Hm+WtUMtTwPvw9Tay5CWfqsWSVk81wqbHNDFpFXyqBmm4/dqA==", "dev": true }, "load-json-file": { @@ -3024,9 +3326,9 @@ }, "dependencies": { "colors": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.3.3.tgz", - "integrity": "sha512-mmGt/1pZqYRjMxB1axhTo16/snVZ5krrKkcmMeVKxzECMMXoCgnvTPp10QgHfcbQZw8Dq2jMNG6je4JlWU0gWg==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", "dev": true } } @@ -3060,15 +3362,6 @@ "integrity": "sha512-c3sIjNUow0+8swNwVpqoH4YCShKNFkMaw6oH1mNS2haDZQqkeZFlHS3dhoeEbKKmJB4vXpJucU6oH75aDYeE9g==", "dev": true }, - "map-age-cleaner": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", - "integrity": "sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==", - "dev": true, - "requires": { - "p-defer": "^1.0.0" - } - }, "map-cache": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", @@ -3096,21 +3389,10 @@ "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", "dev": true }, - "mem": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/mem/-/mem-4.3.0.tgz", - "integrity": "sha512-qX2bG48pTqYRVmDB37rn/6PT7LcR8T7oAX3bf99u1Tt1nzxYfxkgqDwUwolPlXweM0XzBOBFzSx4kfp7KP1s/w==", - "dev": true, - "requires": { - "map-age-cleaner": "^0.1.1", - "mimic-fn": "^2.0.0", - "p-is-promise": "^2.0.0" - } - }, "merge2": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.2.4.tgz", - "integrity": "sha512-FYE8xI+6pjFOhokZu0We3S5NKCirLbCzSh2Usf3qEyr4X8U+0jNg9P8RZ4qz+V2UoECLVwSyzU3LxXBaLGtD3A==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.3.0.tgz", + "integrity": "sha512-2j4DAdlBOkiSZIsaXk4mTE3sRS02yBHAtfy127xRV3bQUFqXkjHCHLW6Scv7DwNRbIWNHH8zpnz9zMaKXIdvYw==", "dev": true }, "methods": { @@ -3161,12 +3443,6 @@ "mime-db": "1.40.0" } }, - "mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true - }, "minimatch": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", @@ -3236,9 +3512,9 @@ } }, "mocha": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.0.tgz", - "integrity": "sha512-qwfFgY+7EKAAUAdv7VYMZQknI7YJSGesxHyhn6qD52DV8UcSZs5XwCifcZGMVIE4a5fbmhvbotxC0DLQ0oKohQ==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.2.tgz", + "integrity": "sha512-FgDS9Re79yU1xz5d+C4rv1G7QagNGHZ+iXF81hO8zY35YZZcLEsJVfFolfsqKFWunATEvNzMK0r/CwWd/szO9A==", "dev": true, "requires": { "ansi-colors": "3.2.3", @@ -3261,40 +3537,11 @@ "supports-color": "6.0.0", "which": "1.3.1", "wide-align": "1.1.3", - "yargs": "13.2.2", - "yargs-parser": "13.0.0", - "yargs-unparser": "1.5.0" + "yargs": "13.3.0", + "yargs-parser": "13.1.1", + "yargs-unparser": "1.6.0" }, "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "cliui": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", - "integrity": "sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==", - "dev": true, - "requires": { - "string-width": "^2.1.1", - "strip-ansi": "^4.0.0", - "wrap-ansi": "^2.0.0" - }, - "dependencies": { - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - } - } - } - }, "glob": { "version": "7.1.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", @@ -3315,47 +3562,12 @@ "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", "dev": true }, - "invert-kv": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", - "integrity": "sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA==", - "dev": true - }, - "lcid": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-2.0.0.tgz", - "integrity": "sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA==", - "dev": true, - "requires": { - "invert-kv": "^2.0.0" - } - }, "ms": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", "dev": true }, - "os-locale": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-3.1.0.tgz", - "integrity": "sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q==", - "dev": true, - "requires": { - "execa": "^1.0.0", - "lcid": "^2.0.0", - "mem": "^4.0.0" - } - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "^3.0.0" - } - }, "supports-color": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", @@ -3364,82 +3576,6 @@ "requires": { "has-flag": "^3.0.0" } - }, - "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", - "dev": true, - "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1" - }, - "dependencies": { - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "^1.0.0" - } - }, - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - } - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "^2.0.0" - } - } - } - }, - "yargs": { - "version": "13.2.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.2.2.tgz", - "integrity": "sha512-WyEoxgyTD3w5XRpAQNYUB9ycVH/PQrToaTXdYXRdOXvEy1l19br+VJsc0vcO8PTGg5ro/l/GY7F/JMEBmI0BxA==", - "dev": true, - "requires": { - "cliui": "^4.0.0", - "find-up": "^3.0.0", - "get-caller-file": "^2.0.1", - "os-locale": "^3.1.0", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^3.0.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^13.0.0" - } - }, - "yargs-parser": { - "version": "13.0.0", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.0.0.tgz", - "integrity": "sha512-w2LXjoL8oRdRQN+hOyppuXs+V/fVAYtpcrRxZuF7Kt/Oc+Jr2uAcVntaUTNT6w5ihoWfFDpNY8CPx1QskxZ/pw==", - "dev": true, - "requires": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } } } }, @@ -3567,9 +3703,9 @@ "dev": true }, "nwsapi": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.1.4.tgz", - "integrity": "sha512-iGfd9Y6SFdTNldEy2L0GUhcarIutFmk+MPWIn9dmj8NMIup03G08uUF2KGbbmv/Ux4RT0VZJoP/sVbWA6d/VIw==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.0.tgz", + "integrity": "sha512-h2AatdwYH+JHiZpv7pt/gSX1XoRGb7L/qSIeuqA6GwYoF9w1vP1cw42TO0aI2pNyshRK5893hNSl+1//vHK7hQ==", "dev": true }, "oauth-sign": { @@ -3816,6 +3952,12 @@ } } }, + "object-inspect": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.7.0.tgz", + "integrity": "sha512-a7pEHdh1xKIAgTySUGgLMx/xwDZskN1Ud6egYYN3EdRW4ZMPNEDUTF+hwy2LUC+Bl+SyLXANnwz/jyh/qutKUw==", + "dev": true + }, "object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", @@ -3944,17 +4086,17 @@ } }, "optionator": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", - "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", + "version": "0.8.3", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", + "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==", "dev": true, "requires": { "deep-is": "~0.1.3", - "fast-levenshtein": "~2.0.4", + "fast-levenshtein": "~2.0.6", "levn": "~0.3.0", "prelude-ls": "~1.1.2", "type-check": "~0.3.2", - "wordwrap": "~1.0.0" + "word-wrap": "~1.2.3" } }, "os-locale": { @@ -3976,24 +4118,12 @@ "windows-release": "^3.1.0" } }, - "p-defer": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-defer/-/p-defer-1.0.0.tgz", - "integrity": "sha1-n26xgvbJqozXQwBKfU+WsZaw+ww=", - "dev": true - }, "p-finally": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", "dev": true }, - "p-is-promise": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-2.1.0.tgz", - "integrity": "sha512-Y3W0wlRPK8ZMRbNq97l4M5otioeA5lm1z7bkNkxCka8HSPjR0xRWmpCmc9utiaLP9Jb1eD8BgeIxTW4AIF45Pg==", - "dev": true - }, "p-limit": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", @@ -4080,9 +4210,9 @@ "dev": true }, "path-to-regexp": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.7.0.tgz", - "integrity": "sha1-Wf3g9DW62suhA6hOnTvGTpa5k30=", + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", + "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", "dev": true, "requires": { "isarray": "0.0.1" @@ -4120,9 +4250,9 @@ "dev": true }, "picomatch": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.0.7.tgz", - "integrity": "sha512-oLHIdio3tZ0qH76NybpeneBhYVj0QFTfXEFTc/B3zKQspYfYYkWYgFsmzo+4kvId/bQRcNkVeguI3y+CD22BtA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.1.1.tgz", + "integrity": "sha512-OYMyqkKzK7blWO/+XZYP6w8hH0LDvkBvdvKukti+7kqYFCiEAk+gI3DWnryapc0Dau05ugGTy0foQ6mqn4AHYA==", "dev": true }, "pify": { @@ -4164,6 +4294,12 @@ "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", "dev": true }, + "prettier": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", + "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==", + "dev": true + }, "process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", @@ -4193,9 +4329,9 @@ "dev": true }, "qs": { - "version": "6.8.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.8.0.tgz", - "integrity": "sha512-tPSkj8y92PfZVbinY1n84i1Qdx75lZjMQYx9WZhnkofyxzw2r7Ho39G3/aEvSUdebxpnnM4LZJCtvE/Aq3+s9w==", + "version": "6.9.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.1.tgz", + "integrity": "sha512-Cxm7/SS/y/Z3MHWSxXb8lIFqgqBowP5JMlTUFyJN88y0SGQhVmZnqFK/PeuMX9LzUyWsqqhNxIyg0jlzq946yA==", "dev": true }, "randexp": { @@ -4362,21 +4498,21 @@ } }, "request-promise-core": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.2.tgz", - "integrity": "sha512-UHYyq1MO8GsefGEt7EprS8UrXsm1TxEvFUX1IMTuSLU2Rh7fTIdFtl8xD7JiEYiWU2dl+NYAjCTksTehQUxPag==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.3.tgz", + "integrity": "sha512-QIs2+ArIGQVp5ZYbWD5ZLCY29D5CfWizP8eWnm8FoGD1TX61veauETVQbrV60662V0oFBkrDOuaBI8XgtuyYAQ==", "dev": true, "requires": { - "lodash": "^4.17.11" + "lodash": "^4.17.15" } }, "request-promise-native": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.7.tgz", - "integrity": "sha512-rIMnbBdgNViL37nZ1b3L/VfPOpSi0TqVDQPAvO6U14lMzOLrt5nilxCQqtDKhZeDiW0/hkCXGoQjhgJd/tCh6w==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.8.tgz", + "integrity": "sha512-dapwLGqkHtwL5AEbfenuzjTYg35Jd6KPytsC2/TLkVMz8rm+tNt72MGUWT1RP/aYawMpN6HqbNGBQaRcBtjQMQ==", "dev": true, "requires": { - "request-promise-core": "1.1.2", + "request-promise-core": "1.1.3", "stealthy-require": "^1.1.1", "tough-cookie": "^2.3.3" } @@ -4687,9 +4823,9 @@ } }, "source-map-support": { - "version": "0.5.13", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.13.tgz", - "integrity": "sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==", + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.16.tgz", + "integrity": "sha512-efyLRJDr68D9hBBNIPWFjhpFzURh+KJykQwvMyW5UiZzYwoF6l4YMMDIJJEyFWxWCqfyxLzz6tSfUFR+kXXsVQ==", "dev": true, "requires": { "buffer-from": "^1.0.0", @@ -4833,6 +4969,26 @@ "integrity": "sha1-q6Nt4I3O5qWjN9SbLqHaGyj8Ds8=", "dev": true }, + "string.prototype.trimleft": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/string.prototype.trimleft/-/string.prototype.trimleft-2.1.0.tgz", + "integrity": "sha512-FJ6b7EgdKxxbDxc79cOlok6Afd++TTs5szo+zJTUyow3ycrRfJVE2pq3vcN53XexvKZu/DJMDfeI/qMiZTrjTw==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + }, + "string.prototype.trimright": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/string.prototype.trimright/-/string.prototype.trimright-2.1.0.tgz", + "integrity": "sha512-fXZTSV55dNBwv16uw+hh5jkghxSnc5oHq+5K/gXgizHwAvMetdAJlHqqoFC1FSDVPYWLkAKl2cxpUT41sV7nSg==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + }, "string_decoder": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", @@ -5035,9 +5191,9 @@ "dev": true }, "ts-node": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.3.0.tgz", - "integrity": "sha512-dyNS/RqyVTDcmNM4NIBAeDMpsAdaQ+ojdf0GOLqE6nwJOgzEkdRNzJywhDfwnuvB10oa6NLVG1rUJQCpRN7qoQ==", + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.5.0.tgz", + "integrity": "sha512-fbG32iZEupNV2E2Fd2m2yt1TdAwR3GTCrJQBHDevIiEBNy1A8kqnyl1fv7jmRmmbtcapFab2glZXHJvfD1ed0Q==", "dev": true, "requires": { "arg": "^4.1.0", @@ -5107,20 +5263,20 @@ "dev": true }, "uglify-js": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.0.tgz", - "integrity": "sha512-W+jrUHJr3DXKhrsS7NUVxn3zqMOFn0hL/Ei6v0anCIMoKC93TjcflTagwIHLW7SfMFfiQuktQyFVCFHGUE0+yg==", + "version": "3.6.8", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.8.tgz", + "integrity": "sha512-XhHJ3S3ZyMwP8kY1Gkugqx3CJh2C3O0y8NPiSxtm1tyD/pktLAkFZsFGpuNfTZddKDQ/bbDBLAd2YyA1pbi8HQ==", "dev": true, "optional": true, "requires": { - "commander": "~2.20.0", + "commander": "~2.20.3", "source-map": "~0.6.1" }, "dependencies": { "commander": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", - "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==", + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", "dev": true, "optional": true }, @@ -5294,9 +5450,9 @@ "dev": true }, "vscode-uri": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-2.0.3.tgz", - "integrity": "sha512-4D3DI3F4uRy09WNtDGD93H9q034OHImxiIcSq664Hq1Y1AScehlP3qqZyTkX/RWxeu0MRMHGkrxYqm2qlDF/aw==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-2.1.1.tgz", + "integrity": "sha512-eY9jmGoEnVf8VE8xr5znSah7Qt1P/xsCdErz+g8HYZtJ7bZqKH5E3d+6oVNm1AC/c6IHUDokbmVXKOi4qPAC9A==", "dev": true }, "w3c-hr-time": { @@ -5424,6 +5580,12 @@ "triple-beam": "^1.2.0" } }, + "word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true + }, "wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", @@ -5448,9 +5610,9 @@ "dev": true }, "write-file-atomic": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.0.tgz", - "integrity": "sha512-EIgkf60l2oWsffja2Sf2AL384dx328c0B+cIYPTQq5q2rOYuDV00/iPFBOUiDKKwKMOhkymH8AidPaRvzfxY+Q==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.1.tgz", + "integrity": "sha512-JPStrIyyVJ6oCSz/691fAjFtefZ6q+fP6tm+OS4Qw6o+TGQxNp1ziY2PgS+X/m0V8OWhZiO/m4xSj+Pr4RrZvw==", "dev": true, "requires": { "imurmurhash": "^0.1.4", @@ -5515,177 +5677,25 @@ } }, "yargs-unparser": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.5.0.tgz", - "integrity": "sha512-HK25qidFTCVuj/D1VfNiEndpLIeJN78aqgR23nL3y4N0U/91cOAzqfHlF8n2BvoNDcZmJKin3ddNSvOxSr8flw==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/yargs-unparser/-/yargs-unparser-1.6.0.tgz", + "integrity": "sha512-W9tKgmSn0DpSatfri0nx52Joq5hVXgeLiqR/5G0sZNDoLZFOr/xjBUDcShCOGNsBnEMNo1KAMBkTej1Hm62HTw==", "dev": true, "requires": { "flat": "^4.1.0", - "lodash": "^4.17.11", - "yargs": "^12.0.5" - }, - "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "cliui": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", - "integrity": "sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==", - "dev": true, - "requires": { - "string-width": "^2.1.1", - "strip-ansi": "^4.0.0", - "wrap-ansi": "^2.0.0" - } - }, - "get-caller-file": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.3.tgz", - "integrity": "sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==", - "dev": true - }, - "invert-kv": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", - "integrity": "sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA==", - "dev": true - }, - "lcid": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-2.0.0.tgz", - "integrity": "sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA==", - "dev": true, - "requires": { - "invert-kv": "^2.0.0" - } - }, - "os-locale": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-3.1.0.tgz", - "integrity": "sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q==", - "dev": true, - "requires": { - "execa": "^1.0.0", - "lcid": "^2.0.0", - "mem": "^4.0.0" - } - }, - "require-main-filename": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", - "integrity": "sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=", - "dev": true - }, - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - } - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "^3.0.0" - } - }, - "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", - "dev": true, - "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1" - }, - "dependencies": { - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "^1.0.0" - } - }, - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - } - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "^2.0.0" - } - } - } - }, - "yargs": { - "version": "12.0.5", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-12.0.5.tgz", - "integrity": "sha512-Lhz8TLaYnxq/2ObqHDql8dX8CJi97oHxrjUcYtzKbbykPtVW9WB+poxI+NM2UIzsMgNCZTIf0AQwsjK5yMAqZw==", - "dev": true, - "requires": { - "cliui": "^4.0.0", - "decamelize": "^1.2.0", - "find-up": "^3.0.0", - "get-caller-file": "^1.0.1", - "os-locale": "^3.0.0", - "require-directory": "^2.1.1", - "require-main-filename": "^1.0.1", - "set-blocking": "^2.0.0", - "string-width": "^2.0.0", - "which-module": "^2.0.0", - "y18n": "^3.2.1 || ^4.0.0", - "yargs-parser": "^11.1.1" - } - }, - "yargs-parser": { - "version": "11.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-11.1.1.tgz", - "integrity": "sha512-C6kB/WJDiaxONLJQnF8ccx9SEeoTTLek8RVbaOIsrAUS8VrBEXfmeSnCZxygc+XC2sNMBIwOOnfcxiynjHsVSQ==", - "dev": true, - "requires": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } - } + "lodash": "^4.17.15", + "yargs": "^13.3.0" } }, "yasway": { - "version": "1.8.4", - "resolved": "https://registry.npmjs.org/yasway/-/yasway-1.8.4.tgz", - "integrity": "sha512-Oo6dFvmazhQU6ceazUm59BVraptSXTDhvpW2K14DcpgeyTAyUUpJjuE7HJ4qyF+Ci6blIaQq9mOVHj8pCFhEjQ==", + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/yasway/-/yasway-1.8.6.tgz", + "integrity": "sha512-zRzjw9Jemtj+1NwAKjE+rExnG+2fY7KMM6PJRIOb8fO+tzq7EdCdp0iZ+O79F3J+/rOXoqFs+Tqa5oVSJq5m1g==", "dev": true, "requires": { "@ts-common/json": "^0.3.0", "@ts-common/string-map": "^0.3.0", + "@ts-common/z-schema": "^4.1.2", "debug": "^4.1.1", "faker": "^4.1.0", "istanbul": "^0.4.5", @@ -5697,10 +5707,28 @@ "native-promise-only": "^0.8.1", "path-to-regexp": "^1.7.0", "swagger-methods": "^1.0.8", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "^4.1.0" + "swagger-schema-official": "2.0.0-bab6bed" }, "dependencies": { + "@ts-common/z-schema": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@ts-common/z-schema/-/z-schema-4.1.2.tgz", + "integrity": "sha512-PDMAza1jpnCpUUSSVf3LBtTyeo5s9xLQlD68gvW3B0j+RbnxYK9CHHCeLOZxBoKviBgr8+tps6ZVmUCcMSmiFw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "core-js": "^3.2.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^11.0.0" + } + }, + "core-js": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.4.0.tgz", + "integrity": "sha512-lQxb4HScV71YugF/X28LtePZj9AB7WqOpcB+YztYxusvhrgZiQXPmCYfPC5LHsw/+ScEtDbXU3xbqH3CjBRmYA==", + "dev": true + }, "debug": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", @@ -5709,6 +5737,12 @@ "requires": { "ms": "^2.1.1" } + }, + "validator": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-11.1.0.tgz", + "integrity": "sha512-qiQ5ktdO7CD6C/5/mYV4jku/7qnqzjrxb3C/Q5wR3vGGinHTgJZN/TdFT3ZX4vXhX2R1PXx42fB1cn5W+uJ4lg==", + "dev": true } } }, @@ -5730,24 +5764,17 @@ } }, "z-schema": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.1.1.tgz", - "integrity": "sha512-0aKvR9FgrghUXXndYNDmAEazl8jykuHSkqkmPw2ZSuTWuLcEscn1zUTbR3LEfyxHl5EEHpqqOpF+Sd7wZvuDxw==", + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.2.2.tgz", + "integrity": "sha512-7bGR7LohxSdlK1EOdvA/OHksvKGE4jTLSjd8dBj9YKT0S43N9pdMZ0Z7GZt9mHrBFhbNTRh3Ky6Eu2MHsPJe8g==", "dev": true, "requires": { "commander": "^2.7.1", - "core-js": "^3.2.1", "lodash.get": "^4.4.2", "lodash.isequal": "^4.5.0", "validator": "^11.0.0" }, "dependencies": { - "core-js": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.2.1.tgz", - "integrity": "sha512-Qa5XSVefSVPRxy2XfUC13WbvqkxhkwB3ve+pgCQveNgYzbM/UxZeu1dcOX/xr4UmfUd+muuvsaxilQzCyUurMw==", - "dev": true - }, "validator": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/validator/-/validator-11.1.0.tgz", diff --git a/.azure-pipelines-preproduction/package.json b/.azure-pipelines-preproduction/package.json index c21610ca5bc0..50d8a883bc17 100644 --- a/.azure-pipelines-preproduction/package.json +++ b/.azure-pipelines-preproduction/package.json @@ -10,20 +10,22 @@ "description": "Tests for Azure REST API Specifications", "license": "MIT", "devDependencies": { - "@azure/avocado": "^0.6.0", - "@azure/rest-api-specs-scripts": "^0.5.1", + "@azure/avocado": "^0.6.2", + "@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" } diff --git a/.azure-pipelines/ModelValidation.yml b/.azure-pipelines/ModelValidation.yml index 15ba9410a6dc..7906dab0c5b1 100644 --- a/.azure-pipelines/ModelValidation.yml +++ b/.azure-pipelines/ModelValidation.yml @@ -4,8 +4,10 @@ jobs: vmImage: 'Ubuntu 16.04' steps: - task: Npm@1 - displayName: 'npm install' + displayName: 'npm ci' inputs: + command: custom verbose: false + customCommand: ci - script: 'npm run tsc && node scripts/modelValidation.js' displayName: 'Model Validation' diff --git a/.azure-pipelines/NetworkValidation.yml b/.azure-pipelines/NetworkValidation.yml index b62841ad85f7..17784464b8c9 100644 --- a/.azure-pipelines/NetworkValidation.yml +++ b/.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 diff --git a/.azure-pipelines/PrettierCheck.yml b/.azure-pipelines/PrettierCheck.yml new file mode 100644 index 000000000000..f0dd05c49e7d --- /dev/null +++ b/.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' \ No newline at end of file diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml new file mode 100644 index 000000000000..521308755773 --- /dev/null +++ b/.azure-pipelines/SDKAutomation.yml @@ -0,0 +1,55 @@ +trigger: + batch: false + branches: + include: + - "*" + +jobs: +- job: "SDKAutomation" + displayName: SDK + pool: + vmImage: 'Ubuntu 18.04' + container: + image: azopenapi.azurecr.io/openapi/sdk-automation:prod + endpoint: azopenapi-registry + timeoutInMinutes: 180 + + variables: + NODE_OPTIONS: '--max-old-space-size=8192' + BLOB_STORAGE_PREFIX: sdkautomation-pipeline + SPEC_REPO: $(Build.Repository.Name) + PR_NUMBER: $(System.PullRequest.PullRequestNumber) + strategy: + matrix: + Net: + SDK_REPO_NAME: azure-sdk-for-net + Java: + SDK_REPO_NAME: azure-sdk-for-java + JavaScript: + SDK_REPO_NAME: azure-sdk-for-js + Python: + SDK_REPO_NAME: azure-sdk-for-python + Go: + SDK_REPO_NAME: azure-sdk-for-go + steps: + - checkout: none + - script: printenv + displayName: Display ENV + - script: git config --global user.email "sdkautomation@microsoft.com" && git config --global user.name "SDK Automation" + displayName: Configure Git + - script: | + curl \ + -s https://api.github.com/repos/$(Build.Repository.Name)/commits/$(Build.SourceVersion)/pulls \ + -H "Accept: application/vnd.github.groot-preview+json" \ + | python3 -c "import sys,json; a=json.load(sys.stdin); print(f'##vso[task.setvariable variable=PR_NUMBER]{a[0][\"number\"]}' if len(a)>0 and a[0][\"base\"][\"ref\"]=='master' else '##vso[task.logissue type=error]Last commit $(Build.SourceVersion) doesnot have a related PR')" + displayName: Get PR_NUMBER + condition: in(variables['Build.Reason'], 'IndividualCI', 'Manual') + - script: sudo chown `id -ng`:`id -ng` . && npm start + env: + BLOB_STORAGE_NAME: $(blob-storage-name) + BLOB_STORAGE_KEY: $(blob-storage-key) + GITHUB_COMMENT_AUTHOR_NAME: $(github-comment-author-name) + GITHUBAPP_ID: $(githubapp-id) + GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key) + displayName: SDK Automation + workingDirectory: /z diff --git a/.azure-pipelines/Semantic.yml b/.azure-pipelines/Semantic.yml index 04627acc1a31..5607478dc9db 100644 --- a/.azure-pipelines/Semantic.yml +++ b/.azure-pipelines/Semantic.yml @@ -4,8 +4,10 @@ jobs: vmImage: 'Ubuntu 16.04' steps: - task: Npm@1 - displayName: 'npm install' + displayName: 'npm ci' inputs: + command: custom verbose: false + customCommand: ci - script: 'npm run tsc && node scripts/semanticValidation.js' displayName: 'Semantic Validation' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dd2afd20e710..345d8c92354c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ MSFT employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapiportal) - one location for using our validation tools and finding your workflow.
### 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 diff --git a/.github/reviewer.yml b/.github/reviewer.yml index 0fd114e380a7..6e53458ab4ef 100644 --- a/.github/reviewer.yml +++ b/.github/reviewer.yml @@ -3,8 +3,6 @@ - group: name: default users: - - githubID: ruowan - email: ruowan@microsoft.com - githubID: raych1 email: raychen@microsoft.com - githubID: MyronFanQiu diff --git a/.github/sla.yml b/.github/sla.yml index 1fcec5d02411..4e4d541c2572 100644 --- a/.github/sla.yml +++ b/.github/sla.yml @@ -1,25 +1,50 @@ --- - scheduleTask: action: sendEmailToAssignee + repoWhitelist: + - Azure/azure-rest-api-specs + scope: pull_request args: - ignoredLabels: - - WaitForARMFeedback - - DoNotMerge - - WaitingForAzureAPIBoard + booleanFilterExpression: "!(WaitForARMFeedback||(DoNotMerge&&(ARMSignedOff||Approved)))" limit: 48h - message: '

Dear Swagger reviewer,

Please response to the PR ${PR_URL}. The PR isn''t updated in 48 hours.


Quick info. Best regards,
Azure Management Experience

' - subject: "Action Required: Please respond to PR ${PR_URL}" - description: "None initial response in 48 hours" - name: no-initial-response + message: '

Dear Swagger reviewer,

Please response to the PR ${URL} . The PR isn''t updated in 48 hours.


Quick info. Best regards,
Azure Management Experience

' + subject: "Action Required: Please respond to PR ${URL}" + description: "None initial response in 48 hours. For public repo." + name: "[PUBLIC] initial response notification" + - scheduleTask: action: sendEmailToAssignee + repoWhitelist: + - Azure/azure-rest-api-specs-pr + scope: pull_request args: - ignoredLabels: - - WaitForARMFeedback - - DoNotMerge - - WaitingForAzureAPIBoard - limit: 5d - message: '

Dear Swagger reviewer,

Please response to the PR ${PR_URL}. The PR isn''t updated in 5 days.


Quick info. Best regards,
Azure Management Experience

' - subject: "Action Required: Please respond to PR ${PR_URL}" - description: "None update in PR in 5 days" - name: no-update-in-5d + booleanFilterExpression: "!(WaitForARMFeedback||Approved-OkToMerge||(DoNotMerge&&(ARMSignedOff||Approved)))" + limit: 48h + message: '

Dear Swagger reviewer,

Please response to the PR ${URL} . The PR isn''t updated in 48 hours.


Quick info. Best regards,
Azure Management Experience

' + subject: "Action Required: Please respond to PR ${URL}" + description: "None initial response in 48 hours. For private repo." + name: "[PRIVATE] initial response notification" + +- scheduleTask: + action: sendEmail + repoWhitelist: + - Azure/azure-rest-api-specs + scope: pull_request + args: + booleanFilterExpression: "(WaitForARMFeedback&&!ARMSignedOff&&!ARMChangesRequested&&!ARMReviewInProgress)" + limit: 3d + subject: "Action Required: Please help to review PR ${URL}" + message: "

Dear ARM review board,

Please review PR ${URL} , the PR is waiting for ARM review over 3 days. Thanks.


Quick infoBest regards,
Azure Management Experience

" + to: armapireview@microsoft.com + description: "send email to ARM team for over 5 days PRs labelled with WaitForARMFeedback" + name: "send email to ARM team" + +- scheduleTask: + action: sendEmailToAssignee + scope: issue + args: + booleanFilterExpression: "triage" + limit: 48h + message: "

Dear Swagger reviewer,

Please response to the issue ${URL} . The issue isn't updated in 48 hours.


Quick info. Best regards,
Azure Management Experience

" + subject: "Action Required: Please respond to issue ${URL}" + cc: Ankun.Ning@microsoft.com diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 000000000000..fe00946b4792 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,5 @@ +{ + "plugins": ["./scripts/prettier-swagger-plugin"], + "parser": "json-swagger", + "printWidth": 20 +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index d09daa2d55e0..000000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "recommendations": [ - "EditorConfig.EditorConfig", - "docsmsft.docs-authoring-pack" - ] -} diff --git a/.vscode/launch.json b/.vscode/launch.json deleted file mode 100644 index fe6da0a7d616..000000000000 --- a/.vscode/launch.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - // Use IntelliSense to learn about possible attributes. - // Hover to view descriptions of existing attributes. - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "type": "node", - "request": "launch", - "name": "Mocha Tests", - "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha", - "args": [ - "--timeout", - "999999", - "--colors", - "${workspaceFolder}/test/syntax.js" - ], - "internalConsoleOptions": "openOnSessionStart" - }, - { - "type": "node", - "request": "launch", - "name": "Launch Program", - "program": "${file}" - } - ] -} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 86500570ba6b..000000000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,24 +0,0 @@ -// Place your settings in this file to overwrite default and user settings. -{ - "json.schemas":[ - { - "fileMatch":[ - "/**/specification/*.json" - ], - "url":"https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json" - }, - { - "fileMatch":[ - "/**/examples/*.json" - ], - "url":"https://raw.githubusercontent.com/Azure/autorest/master/schema/example-schema.json" - }, - { - "fileMatch":[ - "/**/composite*.json" - ], - "url":"https://raw.githubusercontent.com/Azure/autorest/master/schema/composite-swagger.json" - } - ], - "typescript.tsdk": "node_modules\\typescript\\lib" -} \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS index 72b40ee95cb0..14e9cb18e880 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -9,8 +9,8 @@ /specification/batchai/ @alexanderyukhanov /specification/billing/ @wilcobmsft /specification/cdn/ @csmengwan @injyzarif @prakharsharma10 -/specification/cognitiveservices/ @davidlicig @felixwa @yangyuan -/specification/compute/ @huangpf @hyonholee +/specification/cognitiveservices/ @felixwa @yangyuan +/specification/compute/ @hyonholee @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @savyasachisamal @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov /specification/consumption/ @kjeur @panda-wang /specification/containerinstance/ @samkreter /specification/containerregistry/ @djyou @@ -39,11 +39,11 @@ /specification/machinelearning/ @nonstatic2014 /specification/machinelearningcompute/ @shutchings /specification/managementpartner/ @jeffrey-ace -/specification/mediaservices/ @brianblum +/specification/mediaservices/ @giakas /specification/mobileengagement/ @pshrosbree /specification/monitor/ @gucalder /specification/mysql/ @qingqingyuan -/specification/network/ @MikhailTryakhov @number213 +/specification/network/ @MikhailTryakhov @number213 @solhaile @v-shhatt /specification/notificationhubs/ @amolr @smithab /specification/operationalinsights/ @sw47 /specification/operationsmanagement/ @dashimi16 @@ -58,7 +58,8 @@ /specification/relay/ @sethmanheim @v-ajnava /specification/resources/ @Tiano2017 @rajshah11 @vivsriaus /specification/scheduler/ @pinwang81 -/specification/search/ @brjohnstmsft +/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy +/specification/search/resource-manager/ @abhi1509 @miwelsh @tjacobhi /specification/serialconsole/ @amitchat @craigw @asinn826 /specification/service-map/ @daveirwin1 /specification/servicebus/ @sazeesha @v-ajnava diff --git a/README.md b/README.md index 9095d0b4f4b2..0e513616f68c 100644 --- a/README.md +++ b/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. Latest improvement: 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. +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 @@ -17,7 +19,7 @@ The structure of the directory should strictly follow these rules: 1. **Profile**: The profile holder contains the profiles' definition MD files. these files will contain information and references to the snapshots of the RPs' Resource types or Dataplane API versions that represent a specific profile. -1. **Specification**: This folder the is root folder for all Specs (Management and Dataplane) related docs. +1. **Specification**: This folder is the root folder for all Specs (Management and Dataplane) related docs. 1. **{RP-Name} Folders** - each RP will have a separate folder @@ -80,7 +82,7 @@ The structure should appear like so: Currently, the specifications are expected to be in Swagger JSON format ## Next steps -The next step in the process after a spec is completed is to generate SDKs and API reference documentation. Go to the [Azure Developer Experience guide](https://github.com/Azure/adx-documentation-pr) for more information. +The next step in the process after a spec is completed is to generate SDKs and API reference documentation. If you're Microsoft employee, go to the [Azure Developer Experience guide](https://github.com/Azure/adx-documentation-pr) for more information. --- _This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments._ diff --git a/azure-pipelines.yml b/azure-pipelines.yml index e21073678f83..68da20933d61 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,6 +1,9 @@ name: "Azure OpenAPI" -trigger: none +trigger: + branches: + include: + - master variables: TRAVIS: 'true' @@ -19,6 +22,6 @@ jobs: - template: .azure-pipelines/ModelValidation.yml - template: .azure-pipelines/BreakingChange.yml - template: .azure-pipelines/LintDiff.yml -- template: .azure-pipelines/SwaggerToSDK.yml - template: .azure-pipelines/NetworkValidation.yml - template: .azure-pipelines/Spellcheck.yml +- template: .azure-pipelines/PrettierCheck.yml diff --git a/custom-words.txt b/custom-words.txt index 378e1c2560d6..f4ac3a47c96d 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -7,6 +7,7 @@ ABFS Accel ACCELCONTAINER acceptors +accesskey accesspoint accountid accountname @@ -86,6 +87,7 @@ apimtags apimtenant apimusers apimversionsets +apitoken APNS appinsights applynetworkconfigurationupdates @@ -105,6 +107,7 @@ Asns aspnet asyncinfo asyncoperation +atascada australiaeast australiasoutheast authenticatable @@ -122,6 +125,7 @@ autogenerate autogenerated Autogrow autokey +automations autopatching autopool autorest @@ -145,6 +149,8 @@ azuredatalakestore azuredeploy azureedge azurefiles +azurehdinsight +azureiotcentral azuremigrate azureml azuresql @@ -159,6 +165,7 @@ backends backfilling Backoff backupconfig +backupengine backupstorageconfig bacpac badpassword @@ -190,6 +197,7 @@ bingwebsearch Bitbucket Bitlocker bitness +bitrates bitstream biztalk blobfuse @@ -221,6 +229,7 @@ canceldelete cancelpipelinerun canonicalized Carbonite +carretera catenate catenated caverphone @@ -259,8 +268,10 @@ closedlist closedlists Cloudamize cloudapp +cloudproperties cloudsimple clustermonitoring +clustername Cmdkey cmdlet CMMI @@ -270,7 +281,9 @@ CODEGEN codegeneration cognitiveservices colls +colocation COLUMNSTORE +commandshistory commitmentplans Compat compilationjobs @@ -278,6 +291,7 @@ compositeentities computervision CONCURRENTAPPEND Conda +configreferences connectionstrings consumergroups containerid @@ -289,6 +303,7 @@ containersas containerservice contentmoderator continuationtoken +continuousdataexports continuouswebjobs contoso contosodataset @@ -329,6 +344,8 @@ customvision customvisionprediction customvisiontraining CUTOVER +CVEs +CVSS Cyrl databox Databricks @@ -399,12 +416,15 @@ deserializer deserializing destinationshares deterministically +devicecredentials deviceprovisioningservices +devicetemplates devspaces devtestlab devtestlabs dhcp diagnosticcontext +digitaltwins DIMM disableautoscale disablescheduling @@ -459,7 +479,9 @@ entrypoint environmentsettings errordetail errored +ErrorSchema Español +estaba Etag Ethereum evaluateautoscale @@ -481,6 +503,8 @@ exportdevices exporterrors exportstatus externaldatasources +externalDNSIPAddress01 +externalDNSIPAddress02 EYWQ faceapi facelists @@ -519,6 +543,7 @@ FQDNs Français frontdoor fsaction +Fulfilment Fulltext fullyqualified galician @@ -575,6 +600,7 @@ GUID GUIDs GZRS haase +Había hadoop hana hanaonazure @@ -592,6 +618,7 @@ heatmap HHMM HHMMS HHMMSS +hierarchicals hierarchicalentities hierarchyid hivevar @@ -606,7 +633,6 @@ Hubspot hybridconnection hybriddata hybriddatamanager -hyperdrive Hyperdrive Hyperscale hyperv @@ -660,6 +686,7 @@ ipconfigurations ipfilterrules Ipsec ipssl +ipgroups iscloneable Iscsi iscsiservers @@ -693,6 +720,7 @@ JSONLD Jtoken jumpbox jwts +kafkarest Kaliningrad Kbps KECA @@ -704,6 +732,7 @@ keyvaultproperties keyvaulturi keyversion KHTML +Kiswahili Knowledgebase knowledgebases koelner @@ -740,6 +769,7 @@ lifetimepoolstats linkedservices linkexpiryinminutes LISTAFTERID +listbackups listbyrg listbysubscription listcertificates @@ -752,6 +782,7 @@ listsas listsecrets LISTSTATUS listsyncfunctiontriggerstatus +listsyncstatus liveevent liveoutput loadbalancer @@ -778,8 +809,8 @@ lpar LQUP LRO's Lucene -LUNs Lumia +LUNs machinelearning machinelearningcompute machinelearningexperimentation @@ -804,6 +835,7 @@ mariadb Marketo marketplaceagreementsapi marketplaceordering +MAXERRORS maximumblobsize maxmemory maxpagesize @@ -816,6 +848,7 @@ MDATP mediaservices Mesos messagingplan +Metada metadatavalues metaphone metastore @@ -851,6 +884,7 @@ MSGETACLSTATUS MSGETFILESTATUS MSLISTSTATUS MSMCAZR +mucho multiapi Multiclass MULTIJSON @@ -970,6 +1004,8 @@ osdisk osdiskforlinuxsimple osdiskforwindowssimple OSMAM +OSNIC +Otomi outputdirectoryid overprovision overprovisioned @@ -1079,6 +1115,7 @@ qnormal querylogs querypool querystring +Queretaro queueservices quickbooks quicktest @@ -1108,6 +1145,8 @@ reconfiguring recordset recordsetnamesuffix recordsets +recoverypoint +recoverypoints recoveryservices recoveryservicesbackup recoveryservicessiterecovery @@ -1125,6 +1164,7 @@ regionalized regionproposals registeredidentities registryname +rehydrated Reimage reimageall reimaged @@ -1169,6 +1209,7 @@ resourceregion resourcetype Responsys restoreheartbeat +Restproxy resumable resync resynchronization @@ -1185,6 +1226,7 @@ REVOKEACE rgname rhel Rolledback +Rollforward rollouts rolloverdetails rootfs @@ -1254,7 +1296,9 @@ servicemembers servicerunners servicestats servicetopology +servicetopologies serviceunit +serviceunits SETACL SETEXPIRY setissuers @@ -1262,6 +1306,7 @@ SETOWNER SETPERMISSION setsas setvpnclientipsecparameters +sfhealthid sfpkg sharded sharedkey @@ -1288,6 +1333,7 @@ SKU's skus SLES Sllb +slotcopy slotsdiffs slotsswap slowlog @@ -1433,12 +1479,15 @@ timestep timezones tinyint Tokenizes +tombstoned toolchain toolset tooltips +traceroute trafficmanager trafficmanageranalytics trafficmanagerprofiles +tráfico transcoding transcriptmoderationresult translatortext @@ -1557,6 +1606,7 @@ VMQS vmsizes VMSS VMSSVM +vmuuid vmware vmwaretools VMXNET @@ -1570,6 +1620,7 @@ vray Vrops vsphere VSTS +VSTSRM VXLAN waagent WADL @@ -1607,7 +1658,9 @@ Whitelistings Whois Widevine windowsazuremediaservices +windowsesu wlmengg +workbooktemplates Workernode workloadmonitor workspace's @@ -1620,6 +1673,7 @@ XBing Xeon Xero XSMB +Yucatec Ywhk YYMMDD Zabbix @@ -1628,3 +1682,7 @@ Zilla ziplist Zoho zset +MSAZRUSGO +hypervcollectors +vmwarecollectors +updatepolicy diff --git a/documentation/Breaking changes guidelines.md b/documentation/Breaking changes guidelines.md new file mode 100644 index 000000000000..fb5369c8b7d0 --- /dev/null +++ b/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 diff --git a/documentation/Getting started with OpenAPI specifications.md b/documentation/Getting started with OpenAPI specifications.md new file mode 100644 index 000000000000..d7e8f7449dab --- /dev/null +++ b/documentation/Getting started with OpenAPI specifications.md @@ -0,0 +1,23 @@ +### What is an OpenAPI Specification? +OpenAPI Specification (formerly known as Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including: +* Available endpoints (/users) and operations on each endpoint (GET /users, POST /users) +* Operation parameters input and output for each operation +* Authentication methods +* Contact information, license, terms of use and other information + +Currently, we only support `OpenAPI Specification 2.0` or `Swagger V2.0`. + +### Helpful Resources +* **[`Understanding the GitHub flow`](https://guides.github.com/introduction/flow/)** +* **[`Microsft REST-API guidelines`](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md)** +* **[`Structure of a Swagger specification`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/creating-swagger.md)** +* **[`Sample Swagger specification`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json)** +* **[`Sample Readme.md`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/samplereadme.md)** +* **[`Swagger style guide`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-style-cheatsheet.md)** +* **[`Authoring good Swagger descriptions`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-authoring-descriptions.md)** +* **[`Validation tools`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/SwaggerValidationTools.md)** + * [`Validation checks through automated tools`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) + * [`Validation checks done manually`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-manual-guidelines.md) + * [`OAV Validation checks`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) +* **[`Breaking Changes guidelines`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Breaking%20changes%20guidelines.md)** +* **[`x-ms-examples`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/x-ms-examples.md)** diff --git a/documentation/SwaggerValidationTools.md b/documentation/SwaggerValidationTools.md new file mode 100644 index 000000000000..7bfbf2b80272 --- /dev/null +++ b/documentation/SwaggerValidationTools.md @@ -0,0 +1,56 @@ +There are some tools that can help you make sure your specifications conform to the accepted guidelines. Better upfront validation before the final pull request is sent will result in quicker turnaround time. + +## Validation tools available online (for MS FTEs) + +The [`OpenAPI Hub`](https://aka.ms/openapihub) is a great online website to find your workflow and get access to online validation tools. + +Available tools: +- [**`OpenAPI Hub Linter validation tool`**](https://portal.azure-devex-tools.com/app/tools/linter) +- [**`OpenAPI Hub Static validation tool`**](https://portal.azure-devex-tools.com/app/tools/static-validation/static/errors/default) +- [**`OpenAPI Hub Swagger diff tool`**](https://portal.azure-devex-tools.com/app/tools/diff) + +## Swagger Authoring ## + +VS code extension is our recommendation for authoring swaggers. In addition to having a trivial GUI, it also provides the same functionalities as the Linter tool explained below. + +Installation instructions available [here](https://marketplace.visualstudio.com/items?itemName=ms-vscode.autorest). + +An alternative to this is the [OpenAPI Initiative Swagger editor](http://editor.swagger.io/#/). This will help find basic issues in a Swagger file. However, we apply a higher bar than this validator, if this site doesn't show errors doesn't mean that your specification is ready to merge. + +## Validation tools available locally + +The various tools mentioned above are also available for local download. + +- Install Node.js (7.10.0 or greater) + + +**Linter Validator:** + + - `npm install -g autorest` + - `autoRest --azure-validator=true` + + +**Static Validator (Semantic):** + + - `npm install -g oav` + - `bash-3.2$ oav validate-spec ` + +**Static Validator (Model):** + + - `npm install -g oav` + - `bash-3.2$ oav validate-example ` + +**Swagger diff tool** + + - `npm install -g oad@0.1.7` + - `bash-3.2$ oad compare ` + +## I don't agree with the reported errors, how do I suppress them? (for MS FTEs) + +If you believe that the errors reported are false positives or don't apply for your specs, you might consider reviewing the validation errors [suppression process](https://github.com/Azure/adx-documentation-pr/wiki/Swagger-Validation-Errors-Suppression) and request suppression of these errors. + + + + + + diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md new file mode 100644 index 000000000000..707cb739f812 --- /dev/null +++ b/documentation/ci-fix.md @@ -0,0 +1,23 @@ +# CI Fix Guide + +Here are guides to fix some of the CI failure. + +## Spell check + +Please add your words to `./custom-words.txt` if you think you have the correct spell + +## Prettier check + +Please run the following command: + +``` +npm install; npm run prettier-fix +``` + +Or if you want to fix specified service: + +``` +npm install; npm run prettier -- --write "specification//**/*.json" +``` + +Then please commit and push changes made by prettier. diff --git a/package-lock.json b/package-lock.json index 18eec5df7ddd..9bb5d920da32 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,9 +5,9 @@ "requires": true, "dependencies": { "@azure/avocado": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.6.1.tgz", - "integrity": "sha512-GOdVNS/yr7wSQVUGfvR4/nP6+UDBrxqT/McvTsKuy1vWV8BwgKx3JZLB/9mrWYhXQZ257AQkVO9nepxRu9/PsQ==", + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.6.2.tgz", + "integrity": "sha512-DU4TD/+U0aXLjz4bGW+vxst4tXm3/HPiOrNh1BcY00rHRnRbR+ZY7AL/nA4+1P6LVPu8msLUXp6HTqqe4QrbHg==", "dev": true, "requires": { "@azure/openapi-markdown": "^0.9.1", @@ -24,9 +24,9 @@ } }, "@azure/oad": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.6.3.tgz", - "integrity": "sha512-GyyNcsVB8cHW8N5AYWuAh/6qTMcC5Do5o/ue2+dyO5v5iCqZTpOfk4CKZMKJck6qXquXUgdv/HzTOHJJ4Zer9w==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.7.0.tgz", + "integrity": "sha512-voz6Q71GmJpRAThFG5aDWqHiQCc6eL1ajAR0JqbqCsqStQdBauGkGZhOeawkNJIgHnFY3GG9GO/fWhfp36uBWg==", "dev": true, "requires": { "@ts-common/fs": "^0.2.0", @@ -88,19 +88,19 @@ } }, "@azure/rest-api-specs-scripts": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.4.3.tgz", - "integrity": "sha512-FlyENJxKEaMxDLHr2VVtqYJ0dppqPVQqmT/DypAskFeorQKsILH/9ffXkLptmkuAdIRff0O+MI2Q5qHSPfnyzw==", + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.5.7.tgz", + "integrity": "sha512-KbhwZzENz5pB9Me9PxhhuqL7Lru8bmpSOWQ291buvxEYQ+ZwzvHyA0cA8yL5raXZX2IJhslc7ThtcPhAqC0hFw==", "dev": true, "requires": { "@azure/avocado": "^0.4.1", - "@azure/oad": "^0.6.3", + "@azure/oad": "^0.7.0", "@octokit/rest": "^16.25.0", "@ts-common/string-map": "^0.3.0", "fs-extra": "^7.0.1", "glob": "^7.1.3", "js-yaml": "^3.13.1", - "oav": "^0.18.1", + "oav": "0.19.6", "request": "^2.88.0" }, "dependencies": { @@ -151,49 +151,50 @@ "dev": true }, "@octokit/endpoint": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.3.2.tgz", - "integrity": "sha512-gRjteEM9I6f4D8vtwU2iGUTn9RX/AJ0SVXiqBUEuYEWVGGAVjSXdT0oNmghH5lvQNWs8mwt6ZaultuG6yXivNw==", + "version": "5.5.1", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", + "integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", "dev": true, "requires": { - "deepmerge": "4.0.0", + "@octokit/types": "^2.0.0", "is-plain-object": "^3.0.0", - "universal-user-agent": "^3.0.0", - "url-template": "^2.0.8" + "universal-user-agent": "^4.0.0" } }, "@octokit/request": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.0.2.tgz", - "integrity": "sha512-z1BQr43g4kOL4ZrIVBMHwi68Yg9VbkRUyuAgqCp1rU3vbYa69+2gIld/+gHclw15bJWQnhqqyEb7h5a5EqgZ0A==", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.3.1.tgz", + "integrity": "sha512-5/X0AL1ZgoU32fAepTfEoggFinO3rxsMLtzhlUX+RctLrusn/CApJuGFCd0v7GMFhF+8UiCsTTfsu7Fh1HnEJg==", "dev": true, "requires": { - "@octokit/endpoint": "^5.1.0", + "@octokit/endpoint": "^5.5.0", "@octokit/request-error": "^1.0.1", + "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "is-plain-object": "^3.0.0", "node-fetch": "^2.3.0", "once": "^1.4.0", - "universal-user-agent": "^3.0.0" + "universal-user-agent": "^4.0.0" } }, "@octokit/request-error": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.0.4.tgz", - "integrity": "sha512-L4JaJDXn8SGT+5G0uX79rZLv0MNJmfGa4vb4vy1NnpjSnWDLJRy6m90udGwvMmavwsStgbv2QNkPzzTCMmL+ig==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.2.0.tgz", + "integrity": "sha512-DNBhROBYjjV/I9n7A8kVkmQNkqFAMem90dSxqvPq57e2hBr7mNTX98y3R2zDpqMQHVRpBDjsvsfIGgBzy+4PAg==", "dev": true, "requires": { + "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" } }, "@octokit/rest": { - "version": "16.28.7", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.28.7.tgz", - "integrity": "sha512-cznFSLEhh22XD3XeqJw51OLSfyL2fcFKUO+v2Ep9MTAFfFLS1cK1Zwd1yEgQJmJoDnj4/vv3+fGGZweG+xsbIA==", + "version": "16.34.1", + "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.34.1.tgz", + "integrity": "sha512-JUoS12cdktf1fv86rgrjC/RvYLuL+o7p57W7zX1x7ANFJ7OvdV8emvUNkFlcidEaOkYrxK3SoWgQFt3FhNmabA==", "dev": true, "requires": { - "@octokit/request": "^5.0.0", + "@octokit/request": "^5.2.0", "@octokit/request-error": "^1.0.2", "atob-lite": "^2.0.0", "before-after-hook": "^2.0.0", @@ -204,8 +205,16 @@ "lodash.uniq": "^4.5.0", "octokit-pagination-methods": "^1.1.0", "once": "^1.4.0", - "universal-user-agent": "^3.0.0", - "url-template": "^2.0.8" + "universal-user-agent": "^4.0.0" + } + }, + "@octokit/types": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.0.1.tgz", + "integrity": "sha512-YDYgV6nCzdGdOm7wy43Ce8SQ3M5DMKegB8E5sTB/1xrxOdo2yS/KgUgML2N2ZGD621mkbdrAglwTyA4NDOlFFA==", + "dev": true, + "requires": { + "@types/node": ">= 8" } }, "@ts-common/add-position": { @@ -373,6 +382,12 @@ "integrity": "sha512-SGGAhXLHDx+PK4YLNcNGa6goPf9XRWQNAUUbffkwVGGXIxmDKWyGGL4inzq2sPmExu431Ekb9aEMn9BkPqEYFA==", "dev": true }, + "@types/jsonpath": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@types/jsonpath/-/jsonpath-0.2.0.tgz", + "integrity": "sha512-v7qlPA0VpKUlEdhghbDqRoKMxFB3h3Ch688TApBJ6v+XLDdvWCGLJIYiPKGZnS6MAOie+IorCfNYVHOPIHSWwQ==", + "dev": true + }, "@types/minimatch": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.3.tgz", @@ -400,6 +415,12 @@ "@types/node": "*" } }, + "@types/prettier": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-1.18.3.tgz", + "integrity": "sha512-48rnerQdcZ26odp+HOvDGX8IcUkYOCuMc2BodWYTe956MqkHlOGAG4oFQ83cjZ0a4GAgj7mb4GUClxYd2Hlodg==", + "dev": true + }, "@types/retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", @@ -407,9 +428,9 @@ "dev": true }, "abab": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.1.tgz", - "integrity": "sha512-1zSbbCuoIjafKZ3mblY5ikvAb0ODUbqBnFuUb7f6uLeQhhGJ0vEV4ntmtxKLT2WgXCO94E07BjunsIw1jOMPZw==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.2.tgz", + "integrity": "sha512-2scffjvioEmNz0OyDSLGWDfKCVwaKc6l9Pm9kOIREU13ClXZvHpg/nRL5xyjSSSLhOnXqft2HpsAzNEEA8cFFg==", "dev": true }, "abbrev": { @@ -425,9 +446,9 @@ "dev": true }, "acorn-globals": { - "version": "4.3.3", - "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-4.3.3.tgz", - "integrity": "sha512-vkR40VwS2SYO98AIeFvzWWh+xyc2qi9s7OoXSFEGIP/rOJKzjnhykaZJNnHdoq4BL2gGxI5EZOU16z896EYnOQ==", + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-4.3.4.tgz", + "integrity": "sha512-clfQEh21R+D0leSbUdWf3OcfqyaCSAQ8Ryq00bofSekfr9W8u1jyYZo6ir0xu9Gtcf7BjcHJpnbZH7JOCpP60A==", "dev": true, "requires": { "acorn": "^6.0.1", @@ -609,9 +630,9 @@ "dev": true }, "autorest": { - "version": "2.0.4283", - "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4283.tgz", - "integrity": "sha512-3jU9yDR71d2thRnKdPH03DaWbla1Iqnrx2rqUUwbMrb4di36a8+nttCQaTWG7biWPJc6Ke6zSSTzFH0uhya+Nw==", + "version": "2.0.4407", + "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4407.tgz", + "integrity": "sha512-keyeMDb/bVNN8hnDd8o08UC2C1OE8HRhubxksljSvKM5osHIJnoKBA1k3kD7MPAJ/+m6UjDQXci3ronxZeYy+Q==", "dev": true }, "aws-sign2": { @@ -1036,9 +1057,9 @@ "dev": true }, "core-js": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.9.tgz", - "integrity": "sha512-HOpZf6eXmnl7la+cUdMnLvUxKNqLUzJvgIziQ0DiF3JwSImNphIqdGqzj6hIKyX04MmV0poclQ7+wjWvxQyR2A==", + "version": "2.6.10", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.10.tgz", + "integrity": "sha512-I39t74+4t+zau64EN1fE5v2W31Adtc/REhzWN+gWRRXg6WH5qAsZm62DHpQ1+Yhe4047T55jvzz7MUqF/dBBlA==", "dev": true }, "core-util-is": { @@ -1434,9 +1455,9 @@ }, "dependencies": { "whatwg-url": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.0.0.tgz", - "integrity": "sha512-37GeVSIJ3kn1JgKyjiYNmSLP1yzbpb29jdmwBSgkD9h40/hyrR/OifpVUndji3tmwGgD8qpw7iQu3RSbCrBpsQ==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", + "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", "dev": true, "requires": { "lodash.sortby": "^4.7.0", @@ -1473,12 +1494,6 @@ "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", "dev": true }, - "deepmerge": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.0.0.tgz", - "integrity": "sha512-YZ1rOP5+kHor4hMAH+HRQnBQHg+wvS1un1hAOuIcxcBy0hzcUf6Jg2a1w65kpoOUnurOfZbERwjI1TfZxNjcww==", - "dev": true - }, "define-properties": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", @@ -1966,9 +1981,9 @@ "dev": true }, "fast-safe-stringify": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.6.tgz", - "integrity": "sha512-q8BZ89jjc+mz08rSxROs8VsrBBcn1SIw1kq9NjolL509tkABRk9io01RAjSaEv1Xb2uFLt8VtRiZbGp5H8iDtg==", + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.7.tgz", + "integrity": "sha512-Utm6CdzT+6xsDk2m8S6uL8VHxNwI6Jub+e9NYTcAms28T84pTa25GJQV9j0CY0N1rM8hK4x6grpF2BQf+2qwVA==", "dev": true }, "fecha": { @@ -2045,9 +2060,9 @@ "dev": true }, "form-data": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.0.tgz", - "integrity": "sha512-WXieX3G/8side6VIqx44ablyULoGruSde5PNTxoUyo5CeyAMX6nVWUd0rgist/EuX655cjhUhTo1Fo3tRYqbcA==", + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", + "integrity": "sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==", "dev": true, "requires": { "asynckit": "^0.4.0", @@ -2229,9 +2244,9 @@ "dev": true }, "handlebars": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.1.2.tgz", - "integrity": "sha512-nvfrjqvt9xQ8Z/w0ijewdD/vvWDTOweBUm96NTr66Wfvo1mJenBLwcYmPs3TIBP5ruzYGD7Hx/DaM9RmhroGPw==", + "version": "4.5.1", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.1.tgz", + "integrity": "sha512-C29UoFzHe9yM61lOsIlCE5/mQVGrnIOrOq7maQl76L7tYPCgC1og0Ajt6uWnX4ZTxBPnjw+CUvawphwCfJgUnA==", "dev": true, "requires": { "neo-async": "^2.6.0", @@ -2332,9 +2347,9 @@ "dev": true }, "hosted-git-info": { - "version": "2.8.4", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.4.tgz", - "integrity": "sha512-pzXIvANXEFrc5oFFXRMkbLPQ2rXRoDERwDLyrcUxGhaZhgP54BBSl9Oheh7Vv0T090cszWBxPjkQQ5Sq1PbBRQ==", + "version": "2.8.5", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.5.tgz", + "integrity": "sha512-kssjab8CvdXfcXMXVcvsXum4Hwdq9XGtRD3TteMEvEbq0LXyiNQr6AprqKqfeaDXze7SxWvRxdpwE6ku7ikLkg==", "dev": true }, "html-encoding-sniffer": { @@ -2806,13 +2821,13 @@ "dev": true }, "json-schema-faker": { - "version": "0.5.0-rc17", - "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rc17.tgz", - "integrity": "sha512-ZQSLPpnsGiMBuPOHi09cAzhsiIeOcs5im2GAQ2P6XKyWOuetO8eYdYCP/kW7VVU891Ucan0/dl8GYbRA6pf9gw==", + "version": "0.5.0-rc23", + "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rc23.tgz", + "integrity": "sha512-lRzFEnp55TihRzMvUBrtvTlM/aHGhCwfes0/T9bN9OiB2n36/SUFxtMn7anYoES+f95eU3viJ/foXKosCwsiJw==", "dev": true, "requires": { - "json-schema-ref-parser": "^6.0.2", - "jsonpath": "^1.0.1", + "json-schema-ref-parser": "^6.1.0", + "jsonpath-plus": "^1.0.0", "randexp": "^0.5.3" } }, @@ -2867,6 +2882,12 @@ } } }, + "jsonpath-plus": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-1.1.0.tgz", + "integrity": "sha512-ydqTBOuLcFCUr9e7AxJlKCFgxzEQ03HjnIim0hJSdk2NxD8MOsaMOrRgP6XWEm5q3VuDY5+cRT1DM9vLlGo/qA==", + "dev": true + }, "jsonschema": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/jsonschema/-/jsonschema-1.2.4.tgz", @@ -2932,9 +2953,9 @@ } }, "linq": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/linq/-/linq-3.2.0.tgz", - "integrity": "sha512-rdmaLOf2tSCzZ75scdjjN/LVHGZzRu48ql9LdxppQec/pKpPtf8jlMDlPBX3rQnLMcGPtAx8Lel6YbF7jND70g==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/linq/-/linq-3.2.1.tgz", + "integrity": "sha512-BEhjQpbvrKPWlg5m/+PXTHsQoXzzR0UWCvgI8Hm+WtUMtTwPvw9Tay5CWfqsWSVk81wqbHNDFpFXyqBmm4/dqA==", "dev": true }, "load-json-file": { @@ -3027,9 +3048,9 @@ }, "dependencies": { "colors": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.3.3.tgz", - "integrity": "sha512-mmGt/1pZqYRjMxB1axhTo16/snVZ5krrKkcmMeVKxzECMMXoCgnvTPp10QgHfcbQZw8Dq2jMNG6je4JlWU0gWg==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", "dev": true } } @@ -3111,9 +3132,9 @@ } }, "merge2": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.2.4.tgz", - "integrity": "sha512-FYE8xI+6pjFOhokZu0We3S5NKCirLbCzSh2Usf3qEyr4X8U+0jNg9P8RZ4qz+V2UoECLVwSyzU3LxXBaLGtD3A==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.3.0.tgz", + "integrity": "sha512-2j4DAdlBOkiSZIsaXk4mTE3sRS02yBHAtfy127xRV3bQUFqXkjHCHLW6Scv7DwNRbIWNHH8zpnz9zMaKXIdvYw==", "dev": true }, "methods": { @@ -3570,9 +3591,9 @@ "dev": true }, "nwsapi": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.1.4.tgz", - "integrity": "sha512-iGfd9Y6SFdTNldEy2L0GUhcarIutFmk+MPWIn9dmj8NMIup03G08uUF2KGbbmv/Ux4RT0VZJoP/sVbWA6d/VIw==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.0.tgz", + "integrity": "sha512-h2AatdwYH+JHiZpv7pt/gSX1XoRGb7L/qSIeuqA6GwYoF9w1vP1cw42TO0aI2pNyshRK5893hNSl+1//vHK7hQ==", "dev": true }, "oauth-sign": { @@ -3582,21 +3603,22 @@ "dev": true }, "oav": { - "version": "0.18.6", - "resolved": "https://registry.npmjs.org/oav/-/oav-0.18.6.tgz", - "integrity": "sha512-qDMtwnEMZOCdqonzxR7ICbYcSsLkzXpcrZQHsFN9EgGXKUJ9cwPwV2zEba1+fk6WsW/id79cZWfFT0y3XBxiuA==", + "version": "0.19.6", + "resolved": "https://registry.npmjs.org/oav/-/oav-0.19.6.tgz", + "integrity": "sha512-JAATj7YPAm7v7ciPNn3MlnHHsd6GrTPyOJRqW6adWzUg2UQ8zor4jJuotNmsCes5Xq01MqbYOnTEwc/U+or2XA==", "dev": true, "requires": { "@azure/openapi-markdown": "^0.9.0", "@microsoft.azure/autorest-extension-base": "1.0.13", "@ts-common/commonmark-to-markdown": "^1.2.0", - "@ts-common/iterator": "^0.3.1", - "@ts-common/json": "^0.3.0", - "@ts-common/json-parser": "^0.7.0", + "@ts-common/iterator": "^0.3.6", + "@ts-common/json": "^0.3.1", + "@ts-common/json-parser": "^0.8.0", "@ts-common/property-set": "^0.1.0", "@ts-common/source-map": "^0.5.0", "@ts-common/string-map": "^0.3.0", "@ts-common/virtual-fs": "^0.2.0", + "@types/jsonpath": "^0.2.0", "commonmark": "^0.29.0", "glob": "^5.0.15", "globby": "^9.2.0", @@ -3614,24 +3636,11 @@ "vscode-jsonrpc": "^3.6.2", "winston": "^3.2.1", "yargs": "^6.6.0", - "yasway": "^1.8.3", + "yasway": "^1.8.4", "yuml2svg": "^4.2.1", "z-schema": "^4.1.0" }, "dependencies": { - "@ts-common/json-parser": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.7.2.tgz", - "integrity": "sha512-Rb0bA/maGzfjA7ZegDvfDABF+vz2norftJX80aTOLb88gLd2+SnD6gYVg3nZH9FpA5/34JXFDvMs4Fb5GuPoew==", - "dev": true, - "requires": { - "@ts-common/iterator": "^0.3.4", - "@ts-common/json": "^0.3.1", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "tslib": "^1.9.3" - } - }, "ansi-regex": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", @@ -4179,6 +4188,12 @@ "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", "dev": true }, + "prettier": { + "version": "1.18.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz", + "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==", + "dev": true + }, "process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", @@ -4186,9 +4201,9 @@ "dev": true }, "psl": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/psl/-/psl-1.3.0.tgz", - "integrity": "sha512-avHdspHO+9rQTLbv1RO+MPYeP/SzsCoxofjVnHanETfQhTJrmB0HlDoW+EiN/R+C0BZ+gERab9NY0lPN2TxNag==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.4.0.tgz", + "integrity": "sha512-HZzqCGPecFLyoRj5HLfuDSKYTJkAfB5thKBIkRHtGjWwY7p1dAyveIbXIq4tO0KYfDF2tHqPUgY9SDnGm00uFw==", "dev": true }, "pump": { @@ -4208,9 +4223,9 @@ "dev": true }, "qs": { - "version": "6.8.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.8.0.tgz", - "integrity": "sha512-tPSkj8y92PfZVbinY1n84i1Qdx75lZjMQYx9WZhnkofyxzw2r7Ho39G3/aEvSUdebxpnnM4LZJCtvE/Aq3+s9w==", + "version": "6.9.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.0.tgz", + "integrity": "sha512-27RP4UotQORTpmNQDX8BHPukOnBP3p1uUJY5UnDhaJB+rMt9iMsok724XL+UHU23bEFOHRMQ2ZhI99qOWUMGFA==", "dev": true }, "randexp": { @@ -4377,21 +4392,21 @@ } }, "request-promise-core": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.2.tgz", - "integrity": "sha512-UHYyq1MO8GsefGEt7EprS8UrXsm1TxEvFUX1IMTuSLU2Rh7fTIdFtl8xD7JiEYiWU2dl+NYAjCTksTehQUxPag==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.3.tgz", + "integrity": "sha512-QIs2+ArIGQVp5ZYbWD5ZLCY29D5CfWizP8eWnm8FoGD1TX61veauETVQbrV60662V0oFBkrDOuaBI8XgtuyYAQ==", "dev": true, "requires": { - "lodash": "^4.17.11" + "lodash": "^4.17.15" } }, "request-promise-native": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.7.tgz", - "integrity": "sha512-rIMnbBdgNViL37nZ1b3L/VfPOpSi0TqVDQPAvO6U14lMzOLrt5nilxCQqtDKhZeDiW0/hkCXGoQjhgJd/tCh6w==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.8.tgz", + "integrity": "sha512-dapwLGqkHtwL5AEbfenuzjTYg35Jd6KPytsC2/TLkVMz8rm+tNt72MGUWT1RP/aYawMpN6HqbNGBQaRcBtjQMQ==", "dev": true, "requires": { - "request-promise-core": "1.1.2", + "request-promise-core": "1.1.3", "stealthy-require": "^1.1.1", "tough-cookie": "^2.3.3" } @@ -5122,20 +5137,20 @@ "dev": true }, "uglify-js": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.0.tgz", - "integrity": "sha512-W+jrUHJr3DXKhrsS7NUVxn3zqMOFn0hL/Ei6v0anCIMoKC93TjcflTagwIHLW7SfMFfiQuktQyFVCFHGUE0+yg==", + "version": "3.6.7", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.7.tgz", + "integrity": "sha512-4sXQDzmdnoXiO+xvmTzQsfIiwrjUCSA95rSP4SEd8tDb51W2TiDOlL76Hl+Kw0Ie42PSItCW8/t6pBNCF2R48A==", "dev": true, "optional": true, "requires": { - "commander": "~2.20.0", + "commander": "~2.20.3", "source-map": "~0.6.1" }, "dependencies": { "commander": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", - "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==", + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", "dev": true, "optional": true }, @@ -5176,12 +5191,12 @@ } }, "universal-user-agent": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-3.0.0.tgz", - "integrity": "sha512-T3siHThqoj5X0benA5H0qcDnrKGXzU8TKoX15x/tQHw1hQBvIEBHjxQ2klizYsqBOO/Q+WuxoQUihadeeqDnoA==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", + "integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", "dev": true, "requires": { - "os-name": "^3.0.0" + "os-name": "^3.1.0" } }, "universalify": { @@ -5251,12 +5266,6 @@ "integrity": "sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI=", "dev": true }, - "url-template": { - "version": "2.0.8", - "resolved": "https://registry.npmjs.org/url-template/-/url-template-2.0.8.tgz", - "integrity": "sha1-/FZaPMy/93MMd19WQflVV5FDnyE=", - "dev": true - }, "use": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", @@ -5700,13 +5709,14 @@ } }, "yasway": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/yasway/-/yasway-1.8.3.tgz", - "integrity": "sha512-4cBs1eK6HiEe8AvwRNztRdWQnvkuermxRfFVRekk2y/fpna99AQ5b9ByDY/hwWkW80bGipAXoDMI3Ifqol2+tg==", + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/yasway/-/yasway-1.8.6.tgz", + "integrity": "sha512-zRzjw9Jemtj+1NwAKjE+rExnG+2fY7KMM6PJRIOb8fO+tzq7EdCdp0iZ+O79F3J+/rOXoqFs+Tqa5oVSJq5m1g==", "dev": true, "requires": { "@ts-common/json": "^0.3.0", "@ts-common/string-map": "^0.3.0", + "@ts-common/z-schema": "^4.1.2", "debug": "^4.1.1", "faker": "^4.1.0", "istanbul": "^0.4.5", @@ -5718,10 +5728,28 @@ "native-promise-only": "^0.8.1", "path-to-regexp": "^1.7.0", "swagger-methods": "^1.0.8", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "^4.1.0" + "swagger-schema-official": "2.0.0-bab6bed" }, "dependencies": { + "@ts-common/z-schema": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@ts-common/z-schema/-/z-schema-4.1.2.tgz", + "integrity": "sha512-PDMAza1jpnCpUUSSVf3LBtTyeo5s9xLQlD68gvW3B0j+RbnxYK9CHHCeLOZxBoKviBgr8+tps6ZVmUCcMSmiFw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "core-js": "^3.2.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^11.0.0" + } + }, + "core-js": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.3.6.tgz", + "integrity": "sha512-u4oM8SHwmDuh5mWZdDg9UwNVq5s1uqq6ZDLLIs07VY+VJU91i3h4f3K/pgFvtUQPGdeStrZ+odKyfyt4EnKHfA==", + "dev": true + }, "debug": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", @@ -5730,6 +5758,12 @@ "requires": { "ms": "^2.1.1" } + }, + "validator": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-11.1.0.tgz", + "integrity": "sha512-qiQ5ktdO7CD6C/5/mYV4jku/7qnqzjrxb3C/Q5wR3vGGinHTgJZN/TdFT3ZX4vXhX2R1PXx42fB1cn5W+uJ4lg==", + "dev": true } } }, @@ -5751,24 +5785,17 @@ } }, "z-schema": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.1.1.tgz", - "integrity": "sha512-0aKvR9FgrghUXXndYNDmAEazl8jykuHSkqkmPw2ZSuTWuLcEscn1zUTbR3LEfyxHl5EEHpqqOpF+Sd7wZvuDxw==", + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.2.1.tgz", + "integrity": "sha512-UWhAk5QzeIhks51TjHa6d4WexEokzbbwT+Dzq9yOBOx9sNnALo4hpYz9CfJ6IUE2cmzB0vWW3KHePYOfw3L4gQ==", "dev": true, "requires": { "commander": "^2.7.1", - "core-js": "^3.2.1", "lodash.get": "^4.4.2", "lodash.isequal": "^4.5.0", "validator": "^11.0.0" }, "dependencies": { - "core-js": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.2.1.tgz", - "integrity": "sha512-Qa5XSVefSVPRxy2XfUC13WbvqkxhkwB3ve+pgCQveNgYzbM/UxZeu1dcOX/xr4UmfUd+muuvsaxilQzCyUurMw==", - "dev": true - }, "validator": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/validator/-/validator-11.1.0.tgz", diff --git a/package.json b/package.json index 48ec6018caff..682934dbd6ed 100644 --- a/package.json +++ b/package.json @@ -10,8 +10,9 @@ "description": "Tests for Azure REST API Specifications", "license": "MIT", "devDependencies": { - "@azure/avocado": "^0.6.0", - "@azure/rest-api-specs-scripts": "^0.4.0", + "@types/prettier": "^1.18.3", + "@azure/avocado": "^0.6.2", + "@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", @@ -23,7 +24,8 @@ "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": { @@ -34,9 +36,12 @@ "url": "http://github.com/azure/azure-rest-api-specs/issues" }, "scripts": { - "postinstall": "scripts/switch-to-preproduction.sh", + "postinstall": "ts-node scripts/switch-to-preproduction.ts && tsc", "test": "tsc && mocha -t 500000 --reporter min", "spellcheck": "ts-node ./scripts/spellcheck.ts", + "prettier-check": "ts-node ./scripts/prettier-check.ts", + "prettier-fix": "prettier --write specification/**/*.json", + "prettier": "prettier", "tsc": "tsc", "multiapi": "ts-node ./scripts/multiapi.ts" } diff --git a/preproduction-azure-pipelines.yml b/preproduction-azure-pipelines.yml index 4315811071f5..d2b59829aad7 100644 --- a/preproduction-azure-pipelines.yml +++ b/preproduction-azure-pipelines.yml @@ -13,6 +13,5 @@ variables: PREPRODUCTION_PIPELINE: 'true' jobs: -- template: .azure-pipelines/BranchProtectionForPrivateRepo.yml - template: .azure-pipelines/BreakingChange.yml - template: .azure-pipelines/ModelValidation.yml diff --git a/profile/2019-03-01-hybrid.json b/profile/2019-03-01-hybrid.json index 004816d295d6..4c18c211609f 100644 --- a/profile/2019-03-01-hybrid.json +++ b/profile/2019-03-01-hybrid.json @@ -40,6 +40,26 @@ } ] }, + "microsoft.commerce": { + "2015-06-01-preview":[ + { + "resourceType": "estimateResourceSpend", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "subscriberUsageAggregates", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "usageAggregates", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + } + ] + }, "microsoft.compute": { "2017-12-01": [ { @@ -114,6 +134,130 @@ } ] }, + "microsoft.databoxedge":{ + "2019-08-01": [ + { + "resourceType": "dataBoxEdgeDevices", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + }, + { + "resourceType": "dataBoxEdgeDevices/checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + } + ] + }, + "microsoft.devices": { + "2019-07-01-preview":[ + { + "resourceType": "usages", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations/quotas", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations/skus", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "operationResults", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "IotHubs", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "backupProviders", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "backupProviders/operationResults", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + } + ] + }, + "microsoft.eventhubs": { + "2018-01-01-preview": [ + { + "resourceType": "availableClusterRegions", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + }, + { + "resourceType": "clusters", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + }, + { + "resourceType": "locations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + }, + { + "resourceType": "locations/clusterOperations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + }, + { + "resourceType": "locations/namespaceOperations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + }, + { + "resourceType": "namespaces", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json" + } + ], + "2017-04-01": [ + { + "resourceType": "checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/authorizationRules", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs/authorizationRules", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs/consumerGroups", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "sku", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + } + ], + "2015-08-01": [ + { + "resourceType": "checkNamespaceAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json" + } + ] + }, "microsoft.insights": { "2018-01-01": [ { diff --git a/profile/2019-06-01-profile.json b/profile/2019-06-01-profile.json index 1f2cb6b3fdde..9e41ce379840 100644 --- a/profile/2019-06-01-profile.json +++ b/profile/2019-06-01-profile.json @@ -1,7 +1,7 @@ { "info": { "name": "2019-06-01-profile", - "description": "Profile definition targeted for hybrid applications that could run on azure gov general availability version and azure cloud" + "description": "Profile definition targeted for hybrid applications that could run on azure gov general availability version and azure cloud" }, "resourcemanager": { "Microsoft.ADHybridHealthService": { diff --git a/profile/2019-07-01-profile.json b/profile/2019-07-01-profile.json index c032110efdd6..364f30aa073c 100644 --- a/profile/2019-07-01-profile.json +++ b/profile/2019-07-01-profile.json @@ -1,7 +1,7 @@ { "info": { "name": "2019-07-01-profile", - "description": "Profile definition targeted for hybrid applications that could run on azure gov general availability version and azure cloud" + "description": "Profile definition targeted for hybrid applications that could run on azure gov general availability version and azure cloud" }, "resourcemanager": { "Microsoft.ADHybridHealthService": { diff --git a/profile/readme.md b/profile/readme.md index b93c994e0fdf..143a9a93bc03 100644 --- a/profile/readme.md +++ b/profile/readme.md @@ -5,7 +5,7 @@ The files in the folder describe the map of each resource provider's resource types and their supported api versions in the api profile. ## Basics -An API profile represents a map of resource provider namespaces and their API versions. It is a representation of an Azure Platform declaring a set of APIs to be supported across all our clouds.Instead of specifying individual api-versions for each resource type across each namespace, the developer can just align the application to a profile and the tools/SDKs will themselves select the right api-versions as directed by the profile. With API Profiles developers can specify a profile version that applies to an entire template and, at runtime, ARM will pick the right versions of the resources. This way, the customers don’t have to worry about which are the right resource versions to specific clouds. +An API profile represents a map of resource provider namespaces and their API versions. It is a representation of an Azure Platform declaring a set of APIs to be supported across all our clouds. Instead of specifying individual api-versions for each resource type across each namespace, the developer can just align the application to a profile and the tools/SDKs will themselves select the right api-versions as directed by the profile. With API Profiles developers can specify a profile version that applies to an entire template and, at runtime, ARM will pick the right versions of the resources. This way, the customers don’t have to worry about which are the right resource versions to specific clouds. https://docs.microsoft.com/en-us/azure/azure-stack/user/azure-stack-version-profiles @@ -59,4 +59,4 @@ The structure should appear like below: | \---}, \---} } -``` \ No newline at end of file +``` diff --git a/scripts/prettier-check.ts b/scripts/prettier-check.ts new file mode 100644 index 000000000000..0f2e461649fd --- /dev/null +++ b/scripts/prettier-check.ts @@ -0,0 +1,22 @@ +import { runCheckOverChangedSpecFiles, logWarn, logError } from "./utils"; + +runCheckOverChangedSpecFiles({ + onCheckFile: (context, filePath) => { + return context.exec(`prettier -c ${filePath}`); + }, + + onExecError: async (result) => { + if (result.stdout) { + console.log(result.stdout); + } + }, + + onNotInCI: (context) => { + logWarn("Not in CI environment. Run against all the spec json."); + return context.exec(`prettier -c "specification/**/*.json"`); + }, + + onFinalFailed: async () => { + logError('Code style issues found in the above file(s). Please follow https://aka.ms/AA6h31t to fix the issue.') + } +}) \ No newline at end of file diff --git a/scripts/prettier-swagger-plugin.ts b/scripts/prettier-swagger-plugin.ts new file mode 100644 index 000000000000..2d858e33e4fd --- /dev/null +++ b/scripts/prettier-swagger-plugin.ts @@ -0,0 +1,92 @@ +import { ParserOptions, FastPath, Doc, doc, Plugin, AST } from 'prettier'; +import { parsers as bundledParsers } from 'prettier/parser-babylon'; + +const { concat, indent, hardline, join } = doc.builders; + +// Modified from https://github.com/prettier/prettier/blob/master/src/language-js/printer-estree-json.js +const print = (path: FastPath, _: ParserOptions, print: (path: FastPath) => Doc): Doc => { + const node = path.getValue(); + switch (node.type) { + case "JsonRoot": + return concat([path.call(print, "node"), hardline]); + case "ArrayExpression": + return node.elements.length === 0 + ? "[]" + : concat([ + "[", + indent( + concat([ + hardline, + join(concat([",", hardline]), path.map(print, "elements")) + ]) + ), + hardline, + "]" + ]); + case "ObjectExpression": + return node.properties.length === 0 + ? "{}" + : concat([ + "{", + indent( + concat([ + hardline, + join(concat([",", hardline]), path.map(print, "properties")) + ]) + ), + hardline, + "}" + ]); + case "ObjectProperty": + return concat([path.call(print, "key"), ": ", path.call(print, "value")]); + case "UnaryExpression": + return concat([ + node.operator === "+" ? "" : node.operator, + path.call(print, "argument") + ]); + case "NullLiteral": + return "null"; + case "BooleanLiteral": + return node.value ? "true" : "false"; + case "StringLiteral": + return JSON.stringify(node.value); + case "NumericLiteral": + // Modified: Keep numeric literal as-is + return node.extra.raw; + case "Identifier": + return JSON.stringify(node.name); + default: + /* istanbul ignore next */ + throw new Error("unknown type: " + JSON.stringify(node.type)); + } +} + +const preprocess = (ast: AST, _: any): AST => { + return Object.assign({}, ast, { + type: "JsonRoot", + node: ast, + comments: [] + }); +} + +export const languages: Plugin['languages'] = [ + { + name: 'json-swagger', + extensions: ['.json'], + parsers: ['json-swagger'] + } +] + +export const parsers = { + 'json-swagger': { + ...bundledParsers['json-stringify'], + astFormat: 'estree-swagger-customized' + } +}; + +export const printers = { + 'estree-swagger-customized': { + preprocess, + print + } +}; diff --git a/scripts/spellcheck.ts b/scripts/spellcheck.ts index 17c411f3e115..357e943f238e 100644 --- a/scripts/spellcheck.ts +++ b/scripts/spellcheck.ts @@ -1,68 +1,25 @@ -import { devOps, cli, childProcess } from '@azure/avocado'; -import { ExecOptions } from 'child_process'; +import { logError, logWarn, runCheckOverChangedSpecFiles } from './utils'; -const logToAzureDevops = (msg: string, type: string) => { - const lines = msg.split('\n'); - for (const line of lines) { - console.log(`##vso[task.logissue type=${type}]${line}`); - } -} - -const logError = (msg: string) => logToAzureDevops(msg, 'error'); -const logWarn = (msg: string) => logToAzureDevops(msg, 'warning'); - -const verboseExec = async (commandLine: string, options: ExecOptions = {}) => { - console.log(commandLine); - let result: any = {}; - try { - result = await childProcess.exec(commandLine, options); - } catch (e) { - result = e; - } - - if (!result.code) { - return 0; - } - - if (result.stdout) { - logError(result.stdout); - } - if (result.stderr) { - console.error(result.stderr); - } - return result.code; -} +runCheckOverChangedSpecFiles({ + onCheckFile: (context, filePath) => { + return context.exec(`cspell ${filePath}`); + }, -const main = async () => { - const config = cli.defaultConfig(); - const pr = await devOps.createPullRequestProperties(config); - if (pr === undefined) { - logWarn("Not in CI environment. Run against all the spec json."); - return verboseExec(`cspell "specification/**/*.json"`); - } - - const changedJsonFiles = await pr.structuralDiff() - .filter(filePath => filePath.endsWith('.json') && filePath.startsWith('specification/')) - .toArray(); - if (changedJsonFiles.length === 0) { - logWarn("No changed spec json file"); - return 0; - } - - let retCode = 0; - for (const jsonFile of changedJsonFiles) { - const code = await verboseExec(`cspell ${jsonFile}`); - if (code !== 0) { - retCode = code; + onExecError: async (result) => { + if (result.stdout) { + logError(result.stdout); } - } + if (result.stderr) { + console.error(result.stderr); + } + }, - return retCode; -} + onNotInCI: (context) => { + logWarn("Not in CI environment. Run against all the spec json."); + return context.exec(`cspell "specification/**/*.json"`); + }, -main().then(retCode => { - if (retCode !== 0) { + onFinalFailed: async () => { logError('Please fix the error or add words to ./custom-words.txt'); } - process.exit(retCode); -}); +}) \ No newline at end of file diff --git a/scripts/switch-to-preproduction.sh b/scripts/switch-to-preproduction.sh deleted file mode 100755 index fa7bc3d26ab4..000000000000 --- a/scripts/switch-to-preproduction.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/sh - -[ -z "$PREPRODUCTION_PIPELINE" ] || { - echo "Switch to preproduction package.json" - cp -f .azure-pipelines-preproduction/package.json ./package.json - cp -f .azure-pipelines-preproduction/package-lock.json ./package-lock.json - PREPRODUCTION_PIPELINE= npm ci -} diff --git a/scripts/switch-to-preproduction.ts b/scripts/switch-to-preproduction.ts new file mode 100644 index 000000000000..45697f0acb12 --- /dev/null +++ b/scripts/switch-to-preproduction.ts @@ -0,0 +1,22 @@ +import process from 'process'; +import fs from 'fs'; +import childProcess from 'child_process'; + +function main() { + if (!process.env.PREPRODUCTION_PIPELINE) { + return; + } + + console.log('Switch to preproduction package.json'); + fs.copyFileSync('.azure-pipelines-preproduction/package.json', 'package.json'); + fs.copyFileSync('.azure-pipelines-preproduction/package-lock.json', 'package-lock.json'); + + childProcess.execSync('npm ci', { + env: { + ...process.env, + PREPRODUCTION_PIPELINE: '' + } + }); +} + +main(); diff --git a/scripts/utils.ts b/scripts/utils.ts new file mode 100644 index 000000000000..3ffddc3d736a --- /dev/null +++ b/scripts/utils.ts @@ -0,0 +1,81 @@ +import { ExecOptions } from 'child_process'; +import { childProcess, cli, devOps } from '@azure/avocado'; + +export const logToAzureDevops = (msg: string, type: string) => { + const lines = msg.split('\n'); + for (const line of lines) { + console.log(`##vso[task.logissue type=${type}]${line}`); + } +} + +export const logError = (msg: string) => logToAzureDevops(msg, 'error'); +export const logWarn = (msg: string) => logToAzureDevops(msg, 'warning'); + +export type Exec = (commandLine: string, options?: ExecOptions) => Promise; +export type CheckContext = { + exec: Exec; +}; +export type CheckOptions = { + onExecError(result: childProcess.ExecResult): Promise; + onNotInCI(context: CheckContext): Promise; + onCheckFile(context: CheckContext, filePath: string): Promise; + onFinalFailed(context: CheckContext): Promise; +} + +const internalCheck = async (checkOptions: CheckOptions) => { + + const exec = async (commandLine: string, options: ExecOptions = {}) => { + console.log(commandLine); + let result: any = {}; + try { + result = await childProcess.exec(commandLine, options); + } catch (e) { + result = e; + } + + if (!result.code) { + return 0; + } + await checkOptions.onExecError(result); + + return result.code; + } + const context: CheckContext = { exec }; + + const config = cli.defaultConfig(); + const pr = await devOps.createPullRequestProperties(config); + if (pr === undefined) { + return checkOptions.onNotInCI(context); + } + + const changedJsonFiles = (await pr.diff()) + .filter(change => change.kind !== 'Deleted') + .map(change => change.path) + .filter(filePath => filePath.endsWith('.json') && filePath.startsWith('specification/')); + if (changedJsonFiles.length === 0) { + logWarn("No changed spec json file"); + return; + } + + let retCode = 0; + for (const jsonFile of changedJsonFiles) { + const code = await checkOptions.onCheckFile(context, jsonFile); + if (code !== 0) { + retCode = code; + } + } + + if (retCode !== 0) { + await checkOptions.onFinalFailed(context); + } + + process.exit(retCode); +} + +export const runCheckOverChangedSpecFiles = (options: CheckOptions) => { + internalCheck(options).catch(e => { + console.error(e); + logError(`Fatal Error. Please report to adxsr@microsoft.com`); + process.exit(-1); + }); +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md index fba1aeae905d..18d7c396724d 100644 --- a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md @@ -23,7 +23,7 @@ Please also specify `--azure-libraries-for-java=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.advisor +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2017-03 + - tag: package-2016-07-preview +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2017_04_19 + output-folder: $(azure-libraries-for-java-folder)/sdk/advisor/mgmt-v2017_04_19 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2017_03_31 + output-folder: $(azure-libraries-for-java-folder)/sdk/advisor/mgmt-v2017_03_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-07-preview and java + +These settings apply only when `--tag=package-2016-07-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2016_07_12_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/advisor/mgmt-v2016_07_12_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index b9f5292cb02a..19b78bb8ac9b 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Advisor. - - --- + ## Getting Started + To build the SDK for Advisor, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,21 +15,29 @@ To build the SDK for Advisor, simply [Install AutoRest](https://aka.ms/autorest/ To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Advisor API. ``` yaml openapi-type: arm -tag: package-2017-04 +tag: package-2020-01 ``` +### Tag: package-2020-01 + +These settings apply only when `--tag=package-2020-01` is specified on the command line. + +```yaml $(tag) == 'package-2020-01' +input-file: + - Microsoft.Advisor/stable/2020-01-01/advisor.json +``` ### Tag: package-2017-04 These settings apply only when `--tag=package-2017-04` is specified on the command line. @@ -57,10 +65,9 @@ input-file: - Microsoft.Advisor/preview/2016-07-12-preview/advisor.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -77,7 +84,6 @@ swagger-to-sdk: - repo: azure-sdk-for-node ``` - ## Python These settings apply only when `--python` is specified on the command line. @@ -95,11 +101,13 @@ python: package-version: 1.0.1 clear-output-folder: true ``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor/azure/mgmt/advisor ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true @@ -127,69 +135,9 @@ csharp: ## Java -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.advisor -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-03 - - tag: package-2017-04 - - tag: package-2016-07-preview -``` - -### Tag: package-2017-03 and java +See configuration in [readme.java.md](./readme.java.md) -These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2017_03_31 - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_03_31 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2017_04_19 - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_04_19 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-07-preview and java - -These settings apply only when `--tag=package-2016-07-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-07-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2016_07_12_preview - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2016_07_12_preview -regenerate-manager: true -generate-interface: true -``` - - - -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -201,17 +149,17 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Advisor/stable/2020-01-01/advisor.json - $(this-folder)/Microsoft.Advisor/stable/2017-04-19/advisor.json - $(this-folder)/Microsoft.Advisor/stable/2017-03-31/advisor.json - $(this-folder)/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/advisor/resource-manager/readme.typescript.md b/specification/advisor/resource-manager/readme.typescript.md index 0bc1a0164ca7..6281961a7703 100644 --- a/specification/advisor/resource-manager/readme.typescript.md +++ b/specification/advisor/resource-manager/readme.typescript.md @@ -8,5 +8,6 @@ typescript: azure-arm: true package-name: "@azure/arm-advisor" output-folder: "$(typescript-sdks-folder)/sdk/advisor/arm-advisor" + clear-output-folder: true generate-metadata: true ``` diff --git a/specification/alertsmanagement/resource-manager/readme.cli.md b/specification/alertsmanagement/resource-manager/readme.cli.md new file mode 100644 index 000000000000..045547609823 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/readme.cli.md @@ -0,0 +1,31 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + namespace: azure.mgmt.alertsmanagement + test-scenario: + - name: PutActionRule + - name: Create or update a Smart Detector alert rule + - name: Get a Smart Detector alert rule + - name: GetActionRuleById + - name: List alert rules + - name: GetActionRulesResourceGroupWide + - name: Resolve + - name: Get + - name: Resolve + - name: List Smart Detector alert rules + - name: GetById + - name: Summary + - name: List + - name: GetActionRulesSubscriptionWide + - name: ListAlerts + - name: MonService + - name: Patch alert rules + - name: PatchActionRule + - name: changestate + - name: Resolve + - name: Delete a Smart Detector alert rule + - name: DeleteActionRule +``` diff --git a/specification/alertsmanagement/resource-manager/readme.java.md b/specification/alertsmanagement/resource-manager/readme.java.md index ffdebe30586c..242d24295b33 100644 --- a/specification/alertsmanagement/resource-manager/readme.java.md +++ b/specification/alertsmanagement/resource-manager/readme.java.md @@ -30,7 +30,7 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2019-10-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-10-01/$(namespace) +``` + ### Tag: package-2019-02-01-preview and go These settings apply only when `--tag=package-2019-02-01-preview --go` is specified on the command line. diff --git a/specification/appconfiguration/resource-manager/readme.java.md b/specification/appconfiguration/resource-manager/readme.java.md index 930e52f3b904..b8c72208580f 100644 --- a/specification/appconfiguration/resource-manager/readme.java.md +++ b/specification/appconfiguration/resource-manager/readme.java.md @@ -16,9 +16,23 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appconfiguration ``` yaml $(java) && $(multiapi) batch: + - tag: package-2019-10-01 - tag: package-2019-02-01-preview ``` +### Tag: package-2019-10-01 and java + +These settings apply only when `--tag=package-2019-10-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2019-10-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appconfiguration.v2019_10_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/appconfiguration/mgmt-v2019_10_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2019-02-01-preview and java These settings apply only when `--tag=package-2019-02-01-preview --java` is specified on the command line. @@ -27,7 +41,7 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2019-05-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-05-01-preview/$(namespace) +``` diff --git a/specification/appplatform/resource-manager/readme.java.md b/specification/appplatform/resource-manager/readme.java.md new file mode 100644 index 000000000000..789e47493698 --- /dev/null +++ b/specification/appplatform/resource-manager/readme.java.md @@ -0,0 +1,33 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.appplatform +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appplatform +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2019-05-01-preview +``` + +### Tag: package-2019-05-01-preview and java + +These settings apply only when `--tag=package-2019-05-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2019-05-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appplatform.v2019_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/appplatform/mgmt-v2019_05_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/appplatform/resource-manager/readme.md b/specification/appplatform/resource-manager/readme.md new file mode 100644 index 000000000000..2a1d933b2910 --- /dev/null +++ b/specification/appplatform/resource-manager/readme.md @@ -0,0 +1,124 @@ +# AppPlatform + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AppPlatform. + + + +--- +## Getting Started +To build the SDK for AppPlatform, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the AppPlatform API. + +``` yaml +openapi-type: arm +tag: package-2019-05-01-preview +``` + +### Suppression + +``` yaml +directive: + - suppress: EnumInsteadOfBoolean + from: appplatform.json + where: $.definitions.NameAvailability.properties.nameAvailable + reason: The boolean properties 'nameAvailable' is actually boolean value defined by Azure API spec + - suppress: EnumInsteadOfBoolean + from: appplatform.json + where: $.definitions.Dimension.properties.toBeExportedForShoebox + reason: The boolean properties 'toBeExportedForShoebox' is defined by Geneva metrics +``` + +### Tag: package-2019-05-01-preview + +These settings apply only when `--tag=package-2019-05-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-05-01-preview' +input-file: +- Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-net + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-go + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_appplatform'] +``` + + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with AutoRest.0.17.3 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.AppPlatform + output-folder: $(csharp-sdks-folder)/appplatform/Microsoft.Azure.Management.AppPlatform/src/Generated + clear-output-folder: true +``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + diff --git a/specification/appplatform/resource-manager/readme.nodejs.md b/specification/appplatform/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..62380c288ae2 --- /dev/null +++ b/specification/appplatform/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-appplatform + output-folder: $(node-sdks-folder)/lib/services/appplatformManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/appplatform/resource-manager/readme.python.md b/specification/appplatform/resource-manager/readme.python.md new file mode 100644 index 000000000000..5e8d38718850 --- /dev/null +++ b/specification/appplatform/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.appplatform + package-name: azure-mgmt-appplatform + package-version: 0.2.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform +``` diff --git a/specification/appplatform/resource-manager/readme.ruby.md b/specification/appplatform/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..827034b2477a --- /dev/null +++ b/specification/appplatform/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_appplatform +package-version: "0.17.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2019-05-01-preview +``` + +### Tag: package-2019-05-01-preview and ruby + +These settings apply only when `--tag=package-2019-05-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-05-01-preview' && $(ruby) +namespace: "Azure::AppPlatform::Mgmt::V2019_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_appplatform/lib +``` diff --git a/specification/appplatform/resource-manager/readme.typescript.md b/specification/appplatform/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..41364ec19329 --- /dev/null +++ b/specification/appplatform/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-appplatform" + output-folder: "$(typescript-sdks-folder)/sdk/appplatform/arm-appplatform" + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json new file mode 100644 index 000000000000..ef1c4cb174af --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -0,0 +1,407 @@ +{ + "swagger": "2.0", + "info": { + "title": "AttestationClient", + "description": "Describes the interface for the per-tenant enclave service.", + "version": "2018-09-01-preview" + + }, + "x-ms-parameterized-host": { + "hostTemplate": "{tenantBaseUrl}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "tenantBaseUrl", + "x-ms-parameter-location": "client", + "description": "The tenant name, for example https://mytenant.attest.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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": { + "/operations/policy/updatepolicy": { + "post": { + "tags": [ + "policy" + ], + "summary": "Accepts a new policy document and returns a JWT which expresses used in preparation to set attestation policy.", + "operationId": "Policy_PrepareToSet", + "consumes": [ "text/plain" ], + "produces": [ "text/plain", "application/json" ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TeeKind" + }, + { + "name": "PolicyJws", + "in": "body", + "description": "JSON Web Signature (See RFC7515) expressing the new policy", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success - Returns a JWT signed by the metadata signing key that contains the hash of the supplied policy to be set.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "401": { + "description": "Request is unauthorized", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdatePolicy": { + "$ref": "./examples/UpdatePolicy.json" + } + } + } + }, + "/operations/policy/current": { + "get": { + "tags": [ + "policy" + ], + "summary": "Retrieves the current policy for a given kind of TEE.", + "operationId": "Policy_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TeeKind" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AttestationPolicy" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "401": { + "description": "Request is unauthorized", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/Get_Policy.json" + } + } + }, + "put": { + "tags": [ + "policy" + ], + "summary": "Sets the policy for a given kind of TEE.", + "operationId": "Policy_Set", + "consumes": [ "text/plain" ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TeeKind" + }, + { + "name": "newAttestationPolicy", + "in": "body", + "description": "JWT Expressing the new policy", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "401": { + "description": "Request is unauthorized", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Set Policy": { + "$ref": "./examples/Set_Policy.json" + } + } + }, + "post": { + "tags": [ + "policy" + ], + "summary": "Resets the attestation policy for the specified tenant and reverts to the default policy.", + "operationId": "Policy_Reset", + "consumes": [ "text/plain" ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TeeKind" + }, + { + "name": "PolicyJws", + "in": "body", + "description": "JSON Web Signature with an empty policy document", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success - Returns a JWT signed by the metadata signing key that contains the hash of the supplied policy to be set.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "401": { + "description": "Request is unauthorized", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Reset Policy": { + "$ref": "./examples/Reset_Policy.json" + } + } + } + }, + "/certs": { + "get": { + "tags": [ + "attestation" + ], + "summary": "Retrieves the OpenID Configuration data for the Azure Attestation Service", + "description": "Retrieves attestation signing keys in use by the attestation service", + "operationId": "Certs_Get", + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Error processing the request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Reset Policy": { + "$ref": "./examples/Get_Certs.json" + } + } + } + }, + "/.well-known/openid-configuration": { + "get": { + "tags": [ + "attestation" + ], + "summary": "Retrieves the OpenID Configuration data for the Azure Attestation Service", + "description": "Retrieves metadata about the attestation signing keys in use by the attestation service", + "operationId": "MetadataConfiguration_Get", + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Error processing the request", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Reset Policy": { + "$ref": "./examples/Get_MetadataConfiguration.json" + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from Attestation." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for displaying in a user interface." + } + }, + "description": "An error response from Attestation." + }, + "AttestationPolicy": { + "type": "object", + "properties": { + "policy": { + "description": "String-encoded attestation policy document.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version.", + "enum": ["2018-09-01-preview"] + }, + "TeeKind": { + "description": "Specifies the trusted execution environment to be used to validate the evidence", + "name": "tee", + "in": "query", + "type": "string", + "required": true, + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "TeeKind", + "modelAsString": true, + "values": + [ + { "value": "SgxEnclave", "description": "Intel Software Guard eXtensions" }, + { "value": "OpenEnclave", "description": "OpenEnclave extensions to SGX" }, + { "value": "CyResComponent", "description": "IoT Edge validation" }, + { "value": "AzureGuest", "description": "Azure Guest Attestation" } + ] + }, + "enum": [ + "SgxEnclave", + "OpenEnclave", + "CyResComponent", + "AzureGuest" + ] + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Certs.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Certs.json new file mode 100644 index 000000000000..4f025f9bb19b --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Certs.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "x5c": [ + "MIIDazCCAlOgAwIBAgIQR8q7RtYeX6RHhpcFE6HNGDANBgkqhkiG9w0BAQsFADA/MT0wOwYDVQQDEzRodHRwczovL3Rlc3RhdHRlc3RhdGlvbjk5MzQudXMudGVzdC5hdHRlc3QuYXp1cmUubmV0MB4XDTE5MTIxMDAwNDY0OFoXDTIwMTIxMDAwNDY0OFowPzE9MDsGA1UEAxM0aHR0cHM6Ly90ZXN0YXR0ZXN0YXRpb245OTM0LnVzLnRlc3QuYXR0ZXN0LmF6dXJlLm5ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK2v9qLRt313zyzvF3dbPK6AcVO61RhTpRpnlnttwsGIK9A03Rb2bhJLrNsEOHvAPLgSPQWYNrNoeO/X9f9N2w18oZ9ReUIFOj0L0V/trOTYhJJ42f4zsCFz6iX8klqY1vE29y8YL+beqvjXg/8aLaTgs48I+R0coEuJECNADqIL8TCn+UzP1o2tTiH7EKGEG8qpiWRyC25Yl59EITpKrn78v/VMDF6RWkx5uetYDWBXeHi0l48k1lo38BOVOXhJPJvuCKeTSF1Oew7yTsR1QrVviOsnexOTAPtvINYXkLnDzbguNbTfs5FS3RzV017M7kcL3XC+x4B7HkrpvYKUuzsCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgIEMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFIvByEw07sUvWMMQwiVoU5kDb09eMB8GA1UdIwQYMBaAFIvByEw07sUvWMMQwiVoU5kDb09eMA0GCSqGSIb3DQEBCwUAA4IBAQBM+itN5ZPTA7aRzzfnRNVIoixVrege/jPd5r9caHAQdhdOYy/TOxtpTkxYuP+pvlh/8e3F1zV/72iLjZCUYVQQLTRJ9BenF/AA4YJA2y/48UNHm9c+RauUB/KaxfMUolMQ9rkhGYxMBYhq1N3BitJ0m4WlPVzA0eVf1+UMARocasDUDkfmzAj4MAnee9oIBYOLaHe4La5DrLR7MV5v85rkP5Ed/oqznkyKcDT/OPSE3zwVy18BW6GskeLQ+kaTK/7MZM7nnsHO86Wpvjr4EkZZViupIlj/yQED6vWWnR41mCEN/P3MSoKYK1OQtdyhr0sow+CNSjZxz0ndWj7U6Rq1" + ], + "kid": "fAFUDjo0GcezSay/DP2z+LcPe4g/yjCUUAg88BXbDGw=", + "kty": "RSA" + }, + { + "x5c": [ + "MIIDcDCCAligAwIBAgIQAMxeVti2SRWf2t71dDYmaTANBgkqhkiG9w0BAQsFADA1MTMwMQYDVQQDEypBdHRlc3RhdGlvblNlcnZpY2UtTG9jYWxUZXN0LVJlcG9ydFNpZ25pbmcwHhcNMTkwNDI0MTYwMjUwWhcNMjEwNDI0MTYxMjUwWjA1MTMwMQYDVQQDEypBdHRlc3RhdGlvblNlcnZpY2UtTG9jYWxUZXN0LVJlcG9ydFNpZ25pbmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCww8VBqpnKDXo6W+DJbYOXP3BPIFFQi8XnHC59fIco08l7XLwr6mCY+Zzh9qInAENV7fzRJPt4hluCLoUb1vmTY9VdrvSgR5fX4nALJ4FuCFOeLzsxD+5+jP6L0KOT+Lz/3K5s26QaWv4SCNhEz2vI2ffO31AC5w4qfvV+QTK0pI8t9NoW0Afldd7F0E2UowFLHtwVV4lVBtGszvFiIo4X/NpRkj/8e4/0cQdmFlQFFtP/xKg9XP25EZTHrvsmLHSl3tG1F31Om9qsakkL4plTxaOosn71GzyU6BWIh8ZQgSszyTrY8qw0h8KNAot2v3RQrNVYWAxugYVnHhPspofXAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBRQCw4UHmsEwWMJKvERNt2nUVnaIDAdBgNVHQ4EFgQUUAsOFB5rBMFjCSrxETbdp1FZ2iAwDQYJKoZIhvcNAQELBQADggEBAJogTjVhZvG85eig5Qkqt72Hpm4YR9d06UYrwo8nQKoRLsOWW01ySOn7phGvb3dxEyXQmTe10U2x1X1gsGFqnXETXGX11oHnDCWtPk4hK+uVI3Uv2qlX1134nUGoicZb2nRicyUSh8+VHY0ZuOmUs95v+HEMIsEM12AbwWZRKB0+MTAW+4cXSR9LTxRm1pwLS+wKd4A2PYi4TLuO6erZBhZ4BbvmsQtdOaulsUJYWvF72fX+jGQF4WS3qiuN4QaI6Tm/ga3Dcgdfd2oBHePTkxLE252zxlKGZ8kx/WdOuVm/1F24e0fC5M67vlFJvq9VB9I+ElMcGponp8REzQamAIU=" + ], + "kid": "81dsh2B8UUKHZ2JXSOQn-VwfQMU", + "kty": "RSA" + } + ] + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_MetadataConfiguration.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_MetadataConfiguration.json new file mode 100644 index 000000000000..b02fafa04c45 --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_MetadataConfiguration.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "response_types_supported": [ + "token", + "none" + ], + "id_token_signing_alg_values_supported": [ + "RS256" + ], + "revocation_endpoint": "https://mytest.attest.azure.net/revoke", + "jwks_uri": "https://mytest.attest.azure.net/certs", + "claims_supported": [ + "is-debuggable", + "sgx-mrsigner", + "sgx-mrenclave", + "product-id", + "svn", + "tee", + "device_id", + "component_0_id", + "expected_components" + ] + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Policy.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Policy.json new file mode 100644 index 000000000000..fb0da08d47a4 --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_Policy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview", + "tee": "SgxEnclave" + }, + "responses": { + "200": { + "body": { + "policy": "testpolicy" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + }, + "401": { + "description": "Request is unauthorized", + "body": "" + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Reset_Policy.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Reset_Policy.json new file mode 100644 index 000000000000..dc1b591b21d4 --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Reset_Policy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview", + "tee": "SgxEnclave", + "PolicyJws": "eyJhbGciOiJub25lIn0.." + }, + "responses": { + "200": { + "body": "eyJhbGciOiAiUlMyNTYiLCAiamt1IjogImh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9jZXJ0cyIsICJraWQiOiAieWtJd00rcnRNcnhFZkZJVHY2TGZjVG03eWszUkxXRXBkN1lsZmJyTk1JST0iLCAidHlwIjogIkpXVCJ9.eyJhYXMtcG9saWN5SGFzaCI6ICJ2MG9QNG9KWkVKWnh4SXhFNmJiVVAxa1JSbWVfZXgtUHV4NlF0c1U4STdNIiwgImV4cCI6IDE1NzM4NjI5NzQsICJpYXQiOiAxNTczODU5Mzc0LCAiaXNzIjogImh0dHA6Ly9sb2NhbGhvc3Q6ODA4MCIsICJuYmYiOiAxNTczODU5Mzc0fQ.FTMpKwZHJa5l9_Mdxl60FtSDOr9kLRDYw3UAofMXJ-eOEvm4FdNM69YHR6Oy_i1uUEnVDAnMHhR0APTXgKqoR7gDxxfJG_RgiQqsTmQ-ucmXNL2Ck--sH3bz9OfIocPYSN0FBWiq6fgG6iX_oMX1hs-ENsF7B3jSp1nVL8NWtWk" + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + }, + "401": { + "description": "Request is unauthorized", + "body": "" + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Set_Policy.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Set_Policy.json new file mode 100644 index 000000000000..dfa783bcea50 --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/Set_Policy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview", + "tee": "SgxEnclave", + "newAttestationPolicy": "newAttestationPolicyname" + }, + "responses": { + "200": { + "description": "Success" + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + }, + "401": { + "description": "Request is unauthorized", + "body": "" + } + } +} diff --git a/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/UpdatePolicy.json b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/UpdatePolicy.json new file mode 100644 index 000000000000..eec66be114fd --- /dev/null +++ b/specification/attestation/data-plane/Microsoft.Attestation/preview/2018-09-01-preview/examples/UpdatePolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "tenantBaseUrl": "'https://mytest.attest.azure.net'", + "api-version": "2018-09-01-preview", + "tee": "SgxEnclave", + "PolicyJws": "eyJhbGciOiJub25lIn0.eyJBdHRlc3RhdGlvblBvbGljeSI6ICJ7XHJcbiAgICBcIiR2ZXJzaW9uXCI6IDEsXHJcbiAgICBcIiRhbGxvdy1kZWJ1Z2dhYmxlXCIgOiB0cnVlLFxyXG4gICAgXCIkY2xhaW1zXCI6W1xyXG4gICAgICAgIFwiaXMtZGVidWdnYWJsZVwiICxcclxuICAgICAgICBcInNneC1tcnNpZ25lclwiLFxyXG4gICAgICAgIFwic2d4LW1yZW5jbGF2ZVwiLFxyXG4gICAgICAgIFwicHJvZHVjdC1pZFwiLFxyXG4gICAgICAgIFwic3ZuXCIsXHJcbiAgICAgICAgXCJ0ZWVcIixcclxuICAgICAgICBcIk5vdERlYnVnZ2FibGVcIlxyXG4gICAgXSxcclxuICAgIFwiTm90RGVidWdnYWJsZVwiOiB7XCJ5ZXNcIjp7XCIkaXMtZGVidWdnYWJsZVwiOnRydWUsIFwiJG1hbmRhdG9yeVwiOnRydWUsIFwiJHZpc2libGVcIjpmYWxzZX19LFxyXG4gICAgXCJpcy1kZWJ1Z2dhYmxlXCIgOiBcIiRpcy1kZWJ1Z2dhYmxlXCIsXHJcbiAgICBcInNneC1tcnNpZ25lclwiIDogXCIkc2d4LW1yc2lnbmVyXCIsXHJcbiAgICBcInNneC1tcmVuY2xhdmVcIiA6IFwiJHNneC1tcmVuY2xhdmVcIixcclxuICAgIFwicHJvZHVjdC1pZFwiIDogXCIkcHJvZHVjdC1pZFwiLFxyXG4gICAgXCJzdm5cIiA6IFwiJHN2blwiLFxyXG4gICAgXCJ0ZWVcIiA6IFwiJHRlZVwiXHJcbn0ifQ." + }, + "responses": { + "200": { + "body": "eyJhbGciOiAiUlMyNTYiLCAiamt1IjogImh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9jZXJ0cyIsICJraWQiOiAieWtJd00rcnRNcnhFZkZJVHY2TGZjVG03eWszUkxXRXBkN1lsZmJyTk1JST0iLCAidHlwIjogIkpXVCJ9.eyJhYXMtcG9saWN5SGFzaCI6ICJ2MG9QNG9KWkVKWnh4SXhFNmJiVVAxa1JSbWVfZXgtUHV4NlF0c1U4STdNIiwgImV4cCI6IDE1NzM4NjI5NzQsICJpYXQiOiAxNTczODU5Mzc0LCAiaXNzIjogImh0dHA6Ly9sb2NhbGhvc3Q6ODA4MCIsICJuYmYiOiAxNTczODU5Mzc0fQ.FTMpKwZHJa5l9_Mdxl60FtSDOr9kLRDYw3UAofMXJ-eOEvm4FdNM69YHR6Oy_i1uUEnVDAnMHhR0APTXgKqoR7gDxxfJG_RgiQqsTmQ-ucmXNL2Ck--sH3bz9OfIocPYSN0FBWiq6fgG6iX_oMX1hs-ENsF7B3jSp1nVL8NWtWk" + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "error message" + } + } + }, + "401": { + "description": "Request is unauthorized", + "body": "" + } + } +} diff --git a/specification/attestation/data-plane/readme.md b/specification/attestation/data-plane/readme.md new file mode 100644 index 000000000000..1963b714e4da --- /dev/null +++ b/specification/attestation/data-plane/readme.md @@ -0,0 +1,107 @@ +# Attestation + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Attestation. + + + +--- +## Getting Started +To build the SDK for Attestation, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration +Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. + +### Suppression + +``` yaml +directive: + - suppress: R3023 + from: attestation.json + reason: This is the attestation data plane APIs, this rule is not applicable +``` + +### Basic Information +These are the global settings for the Attestation APIs. + +``` yaml +openapi-type: arm +tag: package-2018-09-preview +``` + +### Tag: package-2018-09-preview + +These settings apply only when `--tag=package-2018-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-preview' +input-file: +- Microsoft.Attestation/preview/2018-09-01-preview/attestation.json +``` + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +--- +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Attestation + output-folder: $(csharp-sdks-folder)/attestation/Microsoft.Azure.Attestation/src/Generated + clear-output-folder: true +``` + + + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + diff --git a/specification/attestation/data-plane/readme.python.md b/specification/attestation/data-plane/readme.python.md new file mode 100644 index 000000000000..edcb0a792127 --- /dev/null +++ b/specification/attestation/data-plane/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.attestation + package-name: azure-attestation + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/attestation/azure-attestation/azure/attestation +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/attestation/azure-attestation +``` diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json index 91497bfe111d..bbee9ff59cd9 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -423,6 +423,10 @@ "attestationPolicy": { "type": "string", "description": "Name of attestation policy." + }, + "policySigningCertificates": { + "description": "JSON Web Key Set defining a set of X.509 Certificates that will represent the parent certificate for the signing certificate used for policy operations", + "$ref": "../../../../../common-types/rfcs/rfc7517.json#/definitions/JSONWebKeySet" } } } diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json index b3e4b9d1fc53..e222f28aa981 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json @@ -1,17 +1,16 @@ { "parameters": { - "resourceGroupName": "sample-resource-group", - "serviceName": "sampleservicename", + "resourceGroupName": "MyResourceGroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01-preview", - "providerName": "providername1", + "providerName": "MyAttestationProvider", "creationParams": "test" }, "responses": { "200": { "body": { - "id": "subscriptions/subscriptionID/resourceGroups/resourceGroupID/providers/Microsoft.Attestation/attestationProviders/codes1", - "name": "codes1", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider", + "name": "MyAttestationProvider", "type": "Microsoft.Attestation/attestationProviders", "properties": { "status": "Ready", @@ -21,8 +20,8 @@ }, "201": { "body": { - "id": "subscriptions/subscriptionID/resourceGroups/resourceGroupID/providers/Microsoft.Attestation/attestationProviders/codes1", - "name": "codes1", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider", + "name": "MyAttestationProvider", "type": "Microsoft.Attestation/attestationProviders", "properties": { "status": "Ready", diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json index 2b4a5c9d7fe5..3659e54a0f78 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json @@ -1,10 +1,9 @@ { "parameters": { - "resourceGroupName": "sample-resource-group", - "serviceName": "sampleservicename", + "resourceGroupName": "MyResourceGroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01-preview", - "providerName": "providername1" + "providerName": "MyAttestationProvider" }, "responses": { "202": { diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json index 946007d64975..4df31a7c93e9 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json @@ -1,16 +1,15 @@ { "parameters": { - "resourceGroupName": "sample-resource-group", - "serviceName": "sampleservicename", + "resourceGroupName": "MyResourceGroup", "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01-preview", - "providerName": "providername1" + "providerName": "MyAttestationProvider" }, "responses": { "200": { "body": { - "id": "subscriptions/subscriptionID/resourceGroups/resourceGroupID/providers/Microsoft.Attestation/attestationProviders/codes1", - "name": "codes1", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider", + "name": "MyAttestationProvider", "type": "Microsoft.Attestation/attestationProviders", "properties": { "status": "Ready" diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json index f1ebf8dc62e3..4ab27be179e5 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json @@ -8,8 +8,8 @@ "body": { "value": [ { - "id": "subscriptions/6c96b33e-f5b8-40a6-9011-5cb1c58b0915/resourceGroups/testrg1/providers/Microsoft.Attestation/attestationProviders/codes1", - "name": "codes1", + "id": "subscriptions/6c96b33e-f5b8-40a6-9011-5cb1c58b0915/resourceGroups/testrg1/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider", + "name": "MyAttestationProvider", "type": "Microsoft.Attestation/attestationProviders", "properties": { "status": "Ready" diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json index de5c9261b48d..7e19bb3bcb1b 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "subscriptions/6c96b33e-f5b8-40a6-9011-5cb1c58b0915/resourceGroups/testrg1/providers/Microsoft.Attestation/attestationProviders/codes1", - "name": "codes1", + "id": "subscriptions/6c96b33e-f5b8-40a6-9011-5cb1c58b0915/resourceGroups/testrg1/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider", + "name": "MyAttestationProvider", "type": "Microsoft.Attestation/attestationProviders", "properties": { "status": "Ready" diff --git a/specification/attestation/resource-manager/readme.cli.md b/specification/attestation/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c1990d90a9d8 --- /dev/null +++ b/specification/attestation/resource-manager/readme.cli.md @@ -0,0 +1,17 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + cli-name: attestation + package-name: azure-mgmt-attestation + namespace: azure.mgmt.attestation + test-setup: + - name: Operations_List + - name: AttestationProviders_Create + - name: AttestationProviders_Get + - name: AttestationProviders_List + - name: AttestationProviders_ListByResourceGroup + - name: AttestationProviders_Delete +``` diff --git a/specification/attestation/resource-manager/readme.go.md b/specification/attestation/resource-manager/readme.go.md new file mode 100644 index 000000000000..2e19399e1ee5 --- /dev/null +++ b/specification/attestation/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: attestation + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09-preview +``` + +### Tag: package-2018-09-preview and go + +These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/attestation/resource-manager/readme.md b/specification/attestation/resource-manager/readme.md index 90db381404b1..f6640479ed02 100644 --- a/specification/attestation/resource-manager/readme.md +++ b/specification/attestation/resource-manager/readme.md @@ -50,6 +50,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python + - repo: azure-sdk-for-go ``` ## Python @@ -71,6 +72,9 @@ csharp: clear-output-folder: true ``` +## Go + +See configuration in [readme.go.md](./readme.go.md) ## Multi-API/Profile support for AutoRest v3 generators diff --git a/specification/authorization/resource-manager/readme.java.md b/specification/authorization/resource-manager/readme.java.md index b60b3d715d8a..1a68efeda702 100644 --- a/specification/authorization/resource-manager/readme.java.md +++ b/specification/authorization/resource-manager/readme.java.md @@ -29,7 +29,7 @@ Please also specify `--azure-libraries-for-java-folder=\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getRunbookDraftContent.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getRunbookDraftContent.json index 13530844117f..362002ecc781 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getRunbookDraftContent.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getRunbookDraftContent.json @@ -11,7 +11,7 @@ "headers": { "Content-Type": "text/powershell" }, - "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: \/\/aka.ms\/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/replaceRunbookDraftContent.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/replaceRunbookDraftContent.json index 44dd0fcc84e0..bdd4c1e4beb7 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/replaceRunbookDraftContent.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/replaceRunbookDraftContent.json @@ -5,7 +5,7 @@ "automationAccountName": "ContoseAutomationAccount", "runbookName": "Get-AzureVMTutorial", "api-version": "2015-10-31", - "runbookContent": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: \/\/aka.ms\/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n #>\r\n workflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "runbookContent": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n #>\r\n workflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" }, "responses": { "202": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookContent.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookContent.json index 3b302bd2a268..90664fb2eaa5 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookContent.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookContent.json @@ -11,7 +11,7 @@ "headers": { "Content-Type": "text/powershell" }, - "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: \/\/aka.ms\/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraftContent.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraftContent.json index 3b302bd2a268..90664fb2eaa5 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraftContent.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraftContent.json @@ -11,7 +11,7 @@ "headers": { "Content-Type": "text/powershell" }, - "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: \/\/aka.ms\/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "body": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/replaceRunbookDraftContent.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/replaceRunbookDraftContent.json index 14fe1a06cfd3..e46d7b30ddf8 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/replaceRunbookDraftContent.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/replaceRunbookDraftContent.json @@ -5,7 +5,7 @@ "automationAccountName": "ContoseAutomationAccount", "runbookName": "Get-AzureVMTutorial", "api-version": "2018-06-30", - "runbookContent": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: \/\/aka.ms\/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n #>\r\n workflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" + "runbookContent": "<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n #>\r\n workflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }" }, "responses": { "202": { diff --git a/specification/automation/resource-manager/readme.md b/specification/automation/resource-manager/readme.md index 31b4b001db2f..94ff48b474e3 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -255,7 +255,7 @@ Please also specify `--azure-libraries-for-java=Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

", + "publisherDisplayName": "Canonical", + "publisherIdentifier": "Canonical", + "provisioningState": "Downloading", + "offer": "UbuntuServer", + "offerVersion": "1.0.6", + "sku": "17.10", + "billingPartNumber": "", + "galleryItemIdentity": "Canonical.UbuntuServer1710-ARM.1.0.6", + "iconUris": { + "large": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Large.png", + "wide": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Wide.png", + "medium": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Medium.png", + "small": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Small.png" + }, + "links": [ + { + "displayName": "Linux VM Documentation", + "uri": "https://docs.microsoft.com/azure/virtual-machines/linux/" + }, + { + "displayName": "Ubuntu Documentation", + "uri": "https://help.ubuntu.com/17.10/index.html" + }, + { + "displayName": "FAQ", + "uri": "https://help.ubuntu.com/community/ServerFaq" + }, + { + "displayName": "Pricing details", + "uri": "http://azure.microsoft.com/en-us/pricing/details/virtual-machines/#linux" + } + ], + "legalTerms": "http://www.ubuntu.com/project/about-ubuntu/licensing", + "privacyPolicy": "http://www.ubuntu.com/aboutus/privacypolicy", + "payloadLength": 32212288186, + "productKind": "VirtualMachine", + "productProperties": { + "version": "17.10.201801090" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/b6a34e73-810f-4564-881a-8434c6c2e5c8/resourceGroups/azurestack-activation/providers/Microsoft.AzureBridge.Admin/activations/default/downloadedProducts/Canonical.UbuntuServer1710-ARM.1.0.6", + "name": "default/Canonical.UbuntuServer1710-ARM.1.0.6", + "type": "Microsoft.AzureBridge.Admin/activations/downloadedProducts", + "properties": { + "displayName": "Ubuntu Server 17.10", + "description": "Ubuntu Server 17.10 amd64 20180109 Public Azure, 20180109 Azure China, 20180109 Azure Germany. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 17.10 will be available until July 2018. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

", + "publisherDisplayName": "Canonical", + "publisherIdentifier": "Canonical", + "provisioningState": "Downloading", + "offer": "UbuntuServer", + "offerVersion": "1.0.6", + "sku": "17.10", + "billingPartNumber": "", + "galleryItemIdentity": "Canonical.UbuntuServer1710-ARM.1.0.6", + "iconUris": { + "large": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Large.png", + "wide": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Wide.png", + "medium": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Medium.png", + "small": "https://azstmktprod001.azureedge.net/Canonical.UbuntuServer1710-ARM.1.0.6/icons/Small.png" + }, + "links": [ + { + "displayName": "Linux VM Documentation", + "uri": "https://docs.microsoft.com/azure/virtual-machines/linux/" + }, + { + "displayName": "Ubuntu Documentation", + "uri": "https://help.ubuntu.com/17.10/index.html" + }, + { + "displayName": "FAQ", + "uri": "https://help.ubuntu.com/community/ServerFaq" + }, + { + "displayName": "Pricing details", + "uri": "http://azure.microsoft.com/en-us/pricing/details/virtual-machines/#linux" + } + ], + "legalTerms": "http://www.ubuntu.com/project/about-ubuntu/licensing", + "privacyPolicy": "http://www.ubuntu.com/aboutus/privacypolicy", + "payloadLength": 32212288186, + "productKind": "VirtualMachine", + "productProperties": { + "version": "17.10.201801090" + } + } + } + }, "404": {} } } diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json new file mode 100644 index 000000000000..0f24730ed82f --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json @@ -0,0 +1,204 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans": { + "get": { + "x-ms-examples": { + "Gets the list of action plans": { + "$ref": "./examples/ActionPlan/List.json" + } + }, + "description": "Gets the list of action plans", + "tags": [ + "ActionPlans" + ], + "operationId": "ActionPlans_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionPlanList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans/{planId}": { + "get": { + "x-ms-examples": { + "Gets the specified action plan": { + "$ref": "./examples/ActionPlan/Get.json" + } + }, + "description": "Gets the specified action plan", + "tags": [ + "ActionPlans" + ], + "operationId": "ActionPlans_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionPlanResourceEntity" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + } + }, + "definitions": { + "ActionPlanList": { + "description": "List of action plans", + "properties": { + "value": { + "description": "Array of action plans.", + "type": "array", + "items": { + "$ref": "#/definitions/ActionPlanResourceEntity" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + }, + "ActionPlanResourceEntity": { + "type": "object", + "description": "Action Plan Resource Entity", + "properties": { + "properties": { + "description": "Action Plan Properties", + "$ref": "#/definitions/ActionPlanAdminProperties", + "x-ms-client-flatten": true + }, + "eTag": { + "description": "Entity tag of the resource", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "ActionPlanAdminProperties": { + "type": "object", + "description": "Action Plan Properties", + "properties": { + "actionPlanUri": { + "description": "Action plan uri", + "type": "string" + }, + "resourceGroupName": { + "description": "The target resource group name", + "type": "string" + }, + "subscriptionId": { + "description": "The target subscription identifier", + "type": "string" + }, + "parameters": { + "description": "The deployment parameters in JToken format", + "type": "object", + "$ref": "Deployment.json#/definitions/JTokenString" + }, + "startTime": { + "description": "The deployment start time", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The deployment end time", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "Error Information", + "$ref": "Deployment.json#/definitions/ExtendedErrorInfo" + }, + "provisioningState": { + "description": "The provisioning state", + "type": "string" + }, + "actionPlanInstanceId": { + "description": "Action plan instance identifier", + "type": "string" + }, + "blobContainerName": { + "description": "Blob container name storing the deployment data", + "type": "string" + } + } + } + }, + "parameters": { + "PlanIdParameter": { + "description": "Identifier of the action plan.", + "name": "planId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json new file mode 100644 index 000000000000..9de1d44fcdc7 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json @@ -0,0 +1,233 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans/{planId}/operations": { + "get": { + "x-ms-examples": { + "Lists the action plan operations": { + "$ref": "./examples/ActionPlanOperations/List.json" + } + }, + "description": "Lists the action plan operations", + "tags": [ + "ActionPlanOperations" + ], + "operationId": "ActionPlanOperations_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionPlanOperationsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans/{planId}/operations/{operationId}": { + "get": { + "x-ms-examples": { + "Gets the specified action plan operation": { + "$ref": "./examples/ActionPlanOperations/Get.json" + } + }, + "description": "Gets the specified action plan operation", + "tags": [ + "ActionPlanOperations" + ], + "operationId": "ActionPlanOperations_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionPlanOperationResourceEntity" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + } + }, + "definitions": { + "ActionPlanOperationsList": { + "description": "List of action plan operations", + "properties": { + "value": { + "description": "Array of action plan operations.", + "type": "array", + "items": { + "$ref": "#/definitions/ActionPlanOperationResourceEntity" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + }, + "ActionPlanOperationResourceEntity": { + "type": "object", + "description": "Action Plan Operation Resource Entity", + "properties": { + "properties": { + "description": "Action Plan Properties", + "$ref": "#/definitions/ActionPlanOperationAdminProperties", + "x-ms-client-flatten": true + }, + "eTag": { + "description": "Entity tag of the resource", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "ActionPlanOperationAdminProperties": { + "description": "Action Plan Operation Properties", + "type": "object", + "properties": { + "title": { + "description": "The operation title", + "type": "string" + }, + "description": { + "description": "The operation description", + "type": "string" + }, + "type": { + "description": "The action plan operation type", + "$ref": "#/definitions/ActionType" + }, + "subscriptionId": { + "description": "The target subscription identifier", + "type": "string" + }, + "parameters": { + "description": "The deployment parameters in JToken format", + "type": "object" + }, + "startTime": { + "description": "The deployment start time", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The deployment end time", + "type": "string", + "format": "date-time" + }, + "outputs": { + "description": "The action plan operation outputs in JToken format", + "type": "object" + }, + "error": { + "description": "Error Information", + "$ref": "Deployment.json#/definitions/ExtendedErrorInfo" + }, + "provisioningState": { + "description": "The provisioning state", + "type": "string" + }, + "actionPlanInstanceId": { + "description": "Action plan instance identifier", + "type": "string" + }, + "actionPlanOperationId": { + "description": "Action plan operation identifier", + "type": "string" + }, + "blobContainerName": { + "description": "Blob container name storing the deployment data", + "type": "string" + } + } + }, + "ActionType": { + "description": "Action plan operation type", + "type": "string" + } + }, + "parameters": { + "PlanIdParameter": { + "description": "Identifier of the action plan.", + "name": "planId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "description": "Identifier of the action plan operation.", + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json new file mode 100644 index 000000000000..8d0057c40a0b --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json @@ -0,0 +1,212 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Deployment.Admin/operations": { + "get": { + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Returns the list of supported REST operations.", + "tags": [ + "Deployment" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "Object model of azure resource manager base.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "ID of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "Type of Resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ExtendedErrorInfo": { + "description": "Error information", + "type": "object", + "properties": { + "code": { + "description": "Error Code", + "type": "string" + }, + "message": { + "description": "Error Message", + "type": "string" + }, + "details": { + "description": "Error message details", + "$ref": "#/definitions/ExtendedErrorInfo" + } + } + }, + "JTokenString": { + "description": "Error information", + "type": "object", + "properties": { + "value": { + "description": "Parameters as JToken string", + "type": "string" + } + } + }, + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.", + "type": "string" + }, + "display": { + "description": "Contains the localized display information for this particular operation or action.", + "$ref": "#/definitions/Display" + }, + "origin": { + "description": "Origin for the operation. Eg. User, System", + "type": "string" + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation or action.", + "properties": { + "provider": { + "description": "The localized, friendly version of the resource provider name. The provider name is expected to include the name of the publisher or company responsible. The provider name format should use title case and begin with \"Microsoft\" for first-party services. For example, the provider name may be\"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string" + }, + "resource": { + "description": "The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.", + "type": "string" + }, + "operation": { + "description": "The localized, friendly name for the operation. Use the name as it will displayed to the user.", + "type": "string" + }, + "description": { + "description": "The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.", + "type": "string" + } + } + }, + "OperationList": { + "description": "List of Operations", + "properties": { + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API Version.", + "required": true, + "type": "string", + "default": "2019-01-01" + }, + "LocationParameter": { + "description": "Location of the resource.", + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "default": "2019-01-01" + }, + "ProductIdParameter": { + "name": "productId", + "in": "path", + "description": "The product identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json new file mode 100644 index 000000000000..282c10ba7140 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json @@ -0,0 +1,322 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/fileContainers": { + "get": { + "x-ms-examples": { + "Return file containers list.": { + "$ref": "./examples/FileContainer/List.json" + } + }, + "description": "Returns an array of file containers.", + "tags": [ + "FileContainers" + ], + "operationId": "FileContainers_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileContainersList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/{fileContainerId}": { + "get": { + "x-ms-examples": { + "Return the file container details.": { + "$ref": "./examples/FileContainer/Get.json" + } + }, + "description": "Retrieves the specific file container details.", + "tags": [ + "FileContainers" + ], + "operationId": "FileContainers_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/FileContainerIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileContainer" + } + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "x-ms-examples": { + "Creates a new file container.": { + "$ref": "./examples/FileContainer/Create.json" + } + }, + "description": "Creates a new file container.", + "tags": [ + "FileContainers" + ], + "operationId": "FileContainers_Create", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/FileContainerParameters" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileContainerIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "x-ms-examples": { + "Deletes specified file container.": { + "$ref": "examples/FileContainer/Delete.json" + } + }, + "tags": [ + "FileContainers" + ], + "summary": "Deletes specified file container.", + "description": "Delete an existing file container.", + "operationId": "FileContainers_Delete", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/FileContainerIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not found" + } + } + } + } + }, + "definitions": { + "FileContainer": { + "type": "object", + "description": "File container entity.", + "properties": { + "properties": { + "description": "File Container properties", + "$ref": "#/definitions/FileContainerAdminProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "FileContainerAdminProperties": { + "description": "File Container Properties.", + "type": "object", + "properties": { + "fileContainerId": { + "description": "File container resource identifier containing product manifest.", + "$ref": "#/definitions/FileContainerId" + }, + "sourceUri": { + "description": "The remote file location. This is write-only property, DRP never returns it back to a user.", + "$ref": "#/definitions/SourceUri" + }, + "uri": { + "description": "The file or container Uri. This is read-only property; a user cannot set it.", + "type": "string" + }, + "postCopyAction": { + "description": "Specifies the file post copy action.", + "$ref": "#/definitions/PostCopyAction" + }, + "error": { + "description": "The error response message.", + "$ref": "#/definitions/ErrorInfo" + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string" + } + } + }, + "FileContainersList": { + "description": "List of file containers.", + "properties": { + "value": { + "description": "List of file containers.", + "type": "array", + "items": { + "$ref": "#/definitions/FileContainer" + } + }, + "nextLink": { + "description": "Continuation token.", + "type": "string" + } + } + }, + "ErrorInfo": { + "description": "Extended Error Information.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "details": { + "description": "The detailed error messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInfo" + } + } + } + }, + "PostCopyAction": { + "description": "Specifies the file post copy action.", + "type": "string", + "enum": [ + "None", + "Unzip" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PostCopyAction" + } + }, + "SourceUri": { + "description": "Specifies The remote file location.", + "type": "string" + }, + "FileContainerId": { + "description": "File container resource identifier containing product manifest.", + "type": "string" + }, + "FileContainerParameters": { + "description": "Parameters for creating a new file container.", + "type": "object", + "properties": { + "postCopyAction": { + "description": "Specifies the file post copy action.", + "$ref": "#/definitions/PostCopyAction" + }, + "sourceUri": { + "description": "Specifies The remote file location.", + "$ref": "#/definitions/SourceUri" + } + } + } + }, + "parameters": { + "FileContainerIdParameter": { + "description": "The file container identifier.", + "name": "fileContainerId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileContainerParameters": { + "description": "The parameters required to create a new file container.", + "name": "fileContainerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FileContainerParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json new file mode 100644 index 000000000000..7402634f6765 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json @@ -0,0 +1,565 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments": { + "get": { + "x-ms-examples": { + "List the product deployments": { + "$ref": "./examples/ProductDeployment/List.json" + } + }, + "description": "Invokes bootstrap action on the product deployment", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ProductDeploymentsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}": { + "get": { + "x-ms-examples": { + "Gets the specified product deployment": { + "$ref": "./examples/ProductDeployment/Get.json" + } + }, + "description": "Invokes bootstrap action on the product deployment", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ProductDeploymentResourceEntity" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/bootstrap": { + "post": { + "x-ms-examples": { + "Invokes bootstrap action on the product deployment": { + "$ref": "./examples/ProductDeployment/Bootstrap.json" + } + }, + "description": "Invokes bootstrap action on the product deployment", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_BootStrap", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "ProductDeployment.json#/parameters/BootstrapActionParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "ACCEPTED" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/deploy": { + "post": { + "x-ms-examples": { + "Invokes deploy action on the product": { + "$ref": "./examples/ProductDeployment/Deploy.json" + } + }, + "description": "Invokes deploy action on the product", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_Deploy", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "ProductDeployment.json#/parameters/DeployActionParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "ACCEPTED" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/remove": { + "post": { + "x-ms-examples": { + "Invokes remove action on the product deployment": { + "$ref": "./examples/ProductDeployment/Remove.json" + } + }, + "description": "Invokes remove action on the product deployment", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_Remove", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "ACCEPTED" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/rotateSecrets": { + "post": { + "x-ms-examples": { + "Invokes rotate secrets action on the product deployment": { + "$ref": "./examples/ProductDeployment/RotateSecrets.json" + } + }, + "description": "Invokes rotate secrets action on the product deployment", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_RotateSecrets", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/unlock": { + "post": { + "x-ms-examples": { + "Unlocks the product subscription": { + "$ref": "./examples/ProductDeployment/Unlock.json" + } + }, + "description": "Unlocks the product subscription", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_Unlock", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "ProductDeployment.json#/parameters/UnlockActionParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/{productId}/lock": { + "post": { + "x-ms-examples": { + "locks the product subscription": { + "$ref": "./examples/ProductDeployment/Lock.json" + } + }, + "description": "locks the product subscription", + "tags": [ + "ProductDeployments" + ], + "operationId": "ProductDeployments_Lock", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + } + }, + "definitions": { + "ProductDeploymentsList": { + "description": "List of Product Deployments.", + "properties": { + "value": { + "description": "List of Product Deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDeploymentResourceEntity" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + }, + "ProductDeploymentResourceEntity": { + "type": "object", + "description": "Product deployment entity", + "properties": { + "properties": { + "description": "Product deployment resource properties", + "$ref": "#/definitions/ProductDeploymentsProperties", + "x-ms-client-flatten": true + }, + "eTag": { + "description": "entity tag", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "ProductDeploymentsProperties": { + "type": "object", + "description": "Product deployment resource properties", + "properties": { + "status": { + "description": "Status of the product deployment.", + "$ref": "#/definitions/DeploymentStatus" + }, + "subscriptionId": { + "description": "The product subscription identifier", + "type": "string" + }, + "deployment": { + "description": "The current deployment information", + "$ref": "#/definitions/DeploymentInfo" + }, + "lastSuccessfulDeployment": { + "description": "The last successful deployment information", + "$ref": "#/definitions/DeploymentInfo" + }, + "secretRotation": { + "description": "Resource provider secret rotation information", + "$ref": "#/definitions/SecretRotationInfo" + }, + "internalState": { + "description": "Product deployment resource internal state", + "$ref": "#/definitions/ProductDeploymentsInternalState" + }, + "error": { + "description": "Error Information", + "$ref": "Deployment.json#/definitions/ExtendedErrorInfo" + }, + "externalAccess": { + "description": "Resource provider secret rotation information", + "$ref": "#/definitions/ExternalAccessInfo" + }, + "provisioningState": { + "description": "The provisioning state", + "type": "string" + }, + "productId": { + "description": "The product identifier", + "type": "string" + } + } + }, + "DeploymentStatus": { + "description": "Status of an operation.", + "type": "string", + "enum": [ + "None", + "Bootstrapping", + "BootstrapSucceeded", + "BootstrapFailed", + "Deploying", + "DeploymentSucceeded", + "DeploymentFailed", + "Updating", + "UpdateSucceeded", + "UpdateFailed", + "Removing", + "RemoveFailed", + "SecretRotationInProgress", + "SecretRotationSucceeded", + "SecretRotationFailed", + "Migrated" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + } + }, + "DeploymentInfo": { + "type": "object", + "description": "Resource provider deployment information", + "properties": { + "version": { + "description": "The product version", + "type": "string" + }, + "parameters": { + "description": "The latest deployment parameters as JToken", + "type": "string" + }, + "actionPlanInstanceResourceId": { + "description": "The identifier of the latest action plan instance resource.", + "type": "string" + }, + "eTag": { + "description": "entity tag", + "type": "string" + } + } + }, + "SecretRotationInfo": { + "type": "object", + "description": "Resource provider deployment information", + "properties": { + "secretRotationPlanInstanceResourceId": { + "description": "The identifier of the latest secret rotation plan instance resource.", + "type": "string" + } + } + }, + "ExternalAccessInfo": { + "type": "object", + "description": "Resource provider deployment information", + "properties": { + "principalId": { + "description": "The object identifier of the user, group or service principal that have access to resource provider subscription.", + "type": "string" + }, + "expirationTime": { + "description": "The deployment start time", + "type": "string", + "format": "date-time" + } + } + }, + "ProductDeploymentsInternalState": { + "type": "object", + "description": "Resource type internal state", + "properties": { + "jobId": { + "description": "The latest deployment job identifier", + "type": "string" + }, + "intermediateVaultId": { + "description": "The intermediate vault resource identifier", + "type": "string" + }, + "intermediateVaultUri": { + "description": "The intermediate vault Uri.", + "type": "string" + }, + "externalAccessRoleAssignmentId": { + "description": "The current external access role assignment identifier", + "type": "string" + } + } + }, + "DeployActionParameters": { + "description": "Parameters for deploy action", + "type": "object", + "properties": { + "version": { + "description": "Generic Version object", + "type": "string" + }, + "parameters": { + "description": "Deployment parameters, value in JToken", + "type": "string" + } + } + }, + "BootStrapActionParameters": { + "description": "Parameters for bootstrap action", + "type": "object", + "properties": { + "version": { + "description": "Generic Version object", + "type": "string" + } + } + }, + "UnlockActionParameters": { + "description": "Parameters for bootstrap action", + "type": "object", + "properties": { + "duration": { + "description": "Duration in TimeSpan format(Define which ISO format)", + "type": "string" + } + } + } + }, + "parameters": { + "ResourceGroupParameter": { + "description": "The resource group the resource is located under.", + "name": "resourceGroup", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "BootstrapActionParameter": { + "description": "Represents bootstrap action parameter", + "name": "bootstrapActionParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BootStrapActionParameters" + }, + "x-ms-parameter-location": "method" + }, + "UnlockActionParameter": { + "description": "Represents bootstrap action parameter", + "name": "unlockActionParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UnlockActionParameters" + }, + "x-ms-parameter-location": "method" + }, + "DeployActionParameter": { + "description": "Represents bootstrap action parameter", + "name": "deployActionParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeployActionParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json new file mode 100644 index 000000000000..472aecdd40a0 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json @@ -0,0 +1,270 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages": { + "get": { + "x-ms-examples": { + "Return product packages list.": { + "$ref": "./examples/ProductPackage/List.json" + } + }, + "description": "Returns an array of product packages.", + "tags": [ + "ProductPackages" + ], + "operationId": "ProductPackages_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductPackagesList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{productId}": { + "get": { + "x-ms-examples": { + "Return the product package details.": { + "$ref": "./examples/ProductPackage/Get.json" + } + }, + "description": "Retrieves the specific product package details.", + "tags": [ + "ProductPackages" + ], + "operationId": "ProductPackages_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductPackage" + } + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "x-ms-examples": { + "Creates a new product package.": { + "$ref": "./examples/ProductPackage/Create.json" + } + }, + "description": "Creates a new product package.", + "tags": [ + "ProductPackages" + ], + "operationId": "ProductPackages_Create", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductPackage" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "x-ms-examples": { + "Removes a product package.": { + "$ref": "./examples/ProductPackage/Delete.json" + } + }, + "description": "Deletes a product package.", + "tags": [ + "ProductPackages" + ], + "operationId": "ProductPackages_Delete", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Not found" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ProductPackage": { + "description": "Properties for a product package.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of a product package.", + "$ref": "#/definitions/ProductPackageProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "ProductPackagesList": { + "description": "List of product packages.", + "properties": { + "value": { + "description": "List of product packages.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductPackage" + } + }, + "nextLink": { + "description": "Continuation Token.", + "type": "string" + } + } + }, + "ProductPackageProperties": { + "type": "object", + "description": "Properties for Product package.", + "properties": { + "fileContainerId": { + "description": "File container resource identifier containing product manifest.", + "$ref": "#/definitions/FileContainerId" + }, + "isDeployable": { + "description": "Value indicating whether the package is applicable for deployment.", + "type": "boolean" + }, + "isUpdatable": { + "description": "Value indicating whether the package is applicable for update.", + "type": "boolean" + }, + "productDeploymentId": { + "description": "The identifier of product deployment; null if this version is not installed.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string" + } + } + }, + "FileContainerId": { + "description": "File container resource identifier containing product manifest.", + "type": "string" + }, + "ProductProperties": { + "description": "Additional properties of the product", + "type": "object", + "properties": { + "version": { + "description": "The version of the product", + "type": "string" + } + } + }, + "ProductLink": { + "description": "Link to a product.", + "type": "object", + "properties": { + "displayName": { + "description": "Displayed name of product.", + "type": "string" + }, + "uri": { + "description": "URI to product.", + "type": "string" + } + } + }, + "ProductLinks": { + "description": "List of product links.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductLink" + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json new file mode 100644 index 000000000000..3d2c2693a1d9 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json @@ -0,0 +1,513 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "DeploymentAdminClient", + "description": "Deployment Admin Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{productId}/secrets": { + "get": { + "x-ms-examples": { + "Return product secrets list.": { + "$ref": "./examples/ProductSecret/List.json" + } + }, + "description": "Returns an array of product secrets.", + "tags": [ + "ProductSecrets" + ], + "operationId": "ProductSecrets_List", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductSecretsList" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}": { + "get": { + "x-ms-examples": { + "Return the product package details.": { + "$ref": "./examples/ProductSecret/Get.Json" + } + }, + "description": "Retrieves the specific product secret details.", + "tags": [ + "ProductSecrets" + ], + "operationId": "ProductSecrets_Get", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SecretNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductSecret" + } + }, + "404": { + "description": "Not Found" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}/import": { + "post": { + "x-ms-examples": { + "Imports a product secret.": { + "$ref": "./examples/ProductSecret/Import.json" + } + }, + "description": "Imports a product secret.", + "tags": [ + "ProductSecrets" + ], + "operationId": "ProductSecrets_Import", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/SecretNameParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SecretParameters" + } + ], + "responses": { + "200": { + "description": "Accepted" + }, + "404": { + "description": "Not Found" + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}/validate": { + "post": { + "x-ms-examples": { + "Validates a product secret.": { + "$ref": "./examples/ProductSecret/Validate.json" + } + }, + "description": "Validates a product secret.", + "tags": [ + "ProductSecrets" + ], + "operationId": "ProductSecrets_Validate", + "parameters": [ + { + "$ref": "Deployment.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Deployment.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/SecretNameParameter" + }, + { + "$ref": "Deployment.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SecretParameters" + } + ], + "responses": { + "200": { + "description": "Accepted" + }, + "404": { + "description": "Not Found" + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "ProductSecret": { + "description": "Properties for a product secret.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of a product secret.", + "$ref": "#/definitions/ProductSecretProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "Deployment.json#/definitions/Resource" + } + ] + }, + "ProductSecretsList": { + "description": "List of product secrets.", + "properties": { + "value": { + "description": "List of product secrets.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductSecret" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + }, + "ProductSecretProperties": { + "type": "object", + "description": "Properties of product secret.", + "properties": { + "secretState": { + "description": "The secret state.", + "$ref": "#/definitions/SecretState" + }, + "secretDescriptor": { + "description": "The secret type-specific descriptor.", + "$ref": "#/definitions/SecretDescriptor" + }, + "expiresAfter": { + "description": "The expiration period of the secret (in ISO8601 format).", + "type": "string" + }, + "description": { + "description": "The secret description.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string" + }, + "secretKind": { + "description": "Specifies the secret kind.", + "type": "string", + "enum": [ + "AdHoc", + "Certificate", + "Password", + "StorageAccount", + "SymmetricKey" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "SecretKind" + } + } + } + }, + "SecretDescriptor": { + "description": "The secret type-specific descriptor.", + "type": "object", + "properties": { + "keyLength": { + "description": "The key length.", + "type": "integer" + }, + "alternativeDnsNames": { + "description": "Alternative DNS Names.", + "type": "array", + "items": { + "$ref": "#/definitions/AlternativeDnsNames" + } + }, + "secondaryKeyIsActive": { + "description": "A value indicating whether the secondary or primary storage account key is active as a secret.", + "type": "boolean" + }, + "rotationStatus": { + "description": "The storage account key secret rotation status.", + "type": "string", + "enum": [ + "None", + "PlantNewSak", + "RotateInactiveSak", + "Complete" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RotationStatus" + } + }, + "passwordLength": { + "description": "The minimum password length is 8 characters, and the maximum password length is 128 characters.", + "type": "integer" + }, + "allowedCharacters": { + "description": "The allowed characters in the password", + "type": "string" + }, + "passwordValidationRegex": { + "description": "Password validation regular expression.", + "type": "string" + }, + "subject": { + "description": "Certificate's subject", + "type": "string" + }, + "alternativeIpAddresses": { + "description": "The list of alternative IP addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/AlternativeIpAddresses" + } + } + } + }, + "AlternativeDnsNames": { + "description": "List of alternative DNS names.", + "type": "string" + }, + "AlternativeIpAddresses": { + "description": "List of alternative IP Addresses.", + "type": "string" + }, + "SecretState": { + "description": "Represents the secret state.", + "type": "object", + "properties": { + "status": { + "description": "The secret status.", + "$ref": "#/definitions/SecretStatus" + }, + "rotationStatus": { + "description": "the secret rotation status.", + "$ref": "#/definitions/SecretRotationStatus" + }, + "expirationDate": { + "description": "The secret expiration date.", + "type": "string", + "format": "date-time" + } + } + }, + "SecretStatus": { + "description": "Specifies the secret status.", + "type": "string", + "enum": [ + "NotUploaded", + "Uploaded", + "Deployed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "SecretStatus" + } + }, + "SecretRotationStatus": { + "description": "Specifies the secret rotation status.", + "type": "string", + "enum": [ + "None", + "InProgress", + "Complete" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "SecretRotationStatus" + } + }, + "SecretValue": { + "description": "The secret value in a secure string format.", + "type": "string" + }, + "PfxFileName": { + "description": "The pfx certificate file location.", + "type": "string" + }, + "PfxPassword": { + "description": "The pfx certificate file password as a secure string.", + "type": "string" + }, + "SymmetricKey": { + "description": "The symmetric key as a secure string.", + "type": "string" + }, + "Password": { + "description": "The password as a secure string.", + "type": "string" + }, + "SecretParameters": { + "description": "Parameters required for creating/updating a product secret.", + "type": "object", + "properties": { + "secretValue": { + "description": "The secret value in a secure string format.", + "$ref": "#/definitions/SecretValue" + }, + "pfxFileName": { + "description": "The pfx certificate file location.", + "$ref": "#/definitions/PfxFileName" + }, + "pfxPassword": { + "description": "The pfx certificate file password.", + "$ref": "#/definitions/PfxPassword" + }, + "symmetricKey": { + "description": "The symmetric key.", + "$ref": "#/definitions/SymmetricKey" + }, + "password": { + "description": "The pfx certificate file password.", + "$ref": "#/definitions/Password" + } + } + } + }, + "parameters": { + "SecretNameParameter": { + "description": "The secret name.", + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SecretParameters": { + "description": "The parameters required for creating/updating a product secret.", + "name": "secretParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretParameters" + }, + "x-ms-parameter-location": "method" + }, + "SecretValueParameter": { + "description": "The secret value in a secure string format.", + "name": "secretValue", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretValue" + }, + "x-ms-parameter-location": "method" + }, + "PfxFileNameParameter": { + "description": "The pfx certificate file location.", + "name": "pfxFileName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PfxFileName" + }, + "x-ms-parameter-location": "method" + }, + "PfxPasswordParameter": { + "description": "The pfx certificate file password.", + "name": "pfxPasswordParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PfxPassword" + }, + "x-ms-parameter-location": "method" + }, + "SymmetricKeyParameter": { + "description": "The symmetric key.", + "name": "SymmetricKeyParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SymmetricKey" + }, + "x-ms-parameter-location": "method" + }, + "PasswordParameter": { + "description": "The password.", + "name": "PasswordParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Password" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/Get.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/Get.json new file mode 100644 index 000000000000..bd293cc207e7 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "planId": "5f7d40b0-c504-4ebe-9db2-6f906d0faf6e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "type": "Microsoft.Deployment.Admin/locations/actionplans", + "properties": { + "actionPlanUri": "https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/Deployment/DeploymentPlan.json", + "subscriptionId": "ca13578c-6d3b-4478-b63e-a65c89601d86", + "resourceGroupName": "Microsoft.NullProvider", + "parameters": {}, + "startTime": "2019-10-15T19:29:22.6861068Z", + "endTime": "2019-10-15T19:36:29.5214075Z", + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/List.json new file mode 100644 index 000000000000..9dcd1b396f30 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlan/List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "planId": "5f7d40b0-c504-4ebe-9db2-6f906d0faf6e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "type": "Microsoft.Deployment.Admin/locations/actionplans", + "properties": { + "actionPlanUri": "https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/Deployment/DeploymentPlan.json", + "subscriptionId": "ca13578c-6d3b-4478-b63e-a65c89601d86", + "resourceGroupName": "Microsoft.NullProvider", + "parameters": {}, + "startTime": "2019-10-15T19:29:22.6861068Z", + "endTime": "2019-10-15T19:36:29.5214075Z", + "provisioningState": "Succeeded" + } + } + ] + }, + "404": {} + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/Get.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/Get.json new file mode 100644 index 000000000000..916645557aa5 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/Get.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "planId": "5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "operationId": "DeploySubOwnerResources" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/DeploySubOwnerResources", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/DeploySubOwnerResources", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Deploy Subscription Owner RG", + "description": "Script demonstrating how to deploy resources from subscription owner access.", + "type": "Script", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + }, + "result": true + }, + "startTime": "2019-10-15T19:35:23.8889341Z", + "endTime": "2019-10-15T19:36:29.4432822Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + }, + "result": true + }, + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/List.json new file mode 100644 index 000000000000..90e650806121 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/List.json @@ -0,0 +1,447 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "planId": "5f7d40b0-c504-4ebe-9db2-6f906d0faf6e", + "operationId": "DeploySubOwnerResources" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/DeploySubOwnerResources", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/DeploySubOwnerResources", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Deploy Subscription Owner RG", + "description": "Script demonstrating how to deploy resources from subscription owner access.", + "type": "Script", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + }, + "result": true + }, + "startTime": "2019-10-15T19:35:23.8889341Z", + "endTime": "2019-10-15T19:36:29.4432822Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + }, + "result": true + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/Configure", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/Configure", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Configure Something", + "description": "Sample script demonstrating how to connect to ARM and how get secrets from provider's vault.", + "type": "Script", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "startTime": "2019-10-15T19:33:58.9810782Z", + "endTime": "2019-10-15T19:35:23.7610359Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + }, + "result": true + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/Secrets", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/Secrets", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Import and/or Create Secrets", + "description": "Import external secrets and/or create internal secrets.", + "type": "Template", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "startTime": "2019-10-15T19:33:00.5573558Z", + "endTime": "2019-10-15T19:33:58.9185836Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/AddSubscriptionOwner", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/AddSubscriptionOwner", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Add Subscription Owner", + "description": "Grant subscription owner access to the add-on RP", + "type": "AddSubscriptionOwner", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "startTime": "2019-10-15T19:32:59.882963Z", + "endTime": "2019-10-15T19:33:00.5417235Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/SetVaultAccessPolicies", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/SetVaultAccessPolicies", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Set Vault Access Policies", + "description": "Grant access to provider's vault to provider's identity.", + "type": "Template", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "startTime": "2019-10-15T19:32:00.433533Z", + "endTime": "2019-10-15T19:32:59.8360901Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/Identity", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/Identity", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Create Identity", + "description": "Create provider's identity.", + "type": "Template", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + } + }, + "startTime": "2019-10-15T19:30:30.1106752Z", + "endTime": "2019-10-15T19:32:00.3866607Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + }, + "providerIdentity": { + "identifierUriPrefix": "nullprovider", + "displayName": "Azure Stack - NullProvider App", + "certificates": [ + { + "secretUri": "https://null-provider-vault.adminvault.redmond.ext-n22r1708.masd.stbtest.microsoft.com/secrets/ProviderIdentityClientCertPublic" + } + ], + "applicationId": "99011b1e-4056-44d0-b1a2-9c9ed959f024", + "servicePrincipalObjectId": "b0121fa7-fcdb-4d09-80ef-cdcc9d04493b", + "identifierUris": [ + "https://nullprovider.rp.azurestackci02.onmicrosoft.com/3d6d059d-5b08-4432-bc39-a29fe8de30c1" + ], + "tenantId": "6a8092d6-08d4-45af-894a-121400ef36a1", + "loginBaseEndpoint": "https://login.microsoftonline.com/", + "graphBaseEndpoint": "https://graph.windows.net/", + "graphResource": "https://graph.windows.net/", + "graphApiVersion": "1.6", + "identitySystem": "AzureAD", + "provisioningState": "Succeeded" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/CreateVault", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/CreateVault", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Create Vault", + "description": "Create provider's vault with minimal access policies.", + "type": "Template", + "parameters": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + } + }, + "startTime": "2019-10-15T19:29:56.6504711Z", + "endTime": "2019-10-15T19:30:30.0794295Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/operations/Constants", + "name": "global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e/Constants", + "type": "Microsoft.Deployment.Admin/locations/actionplans/operations", + "properties": { + "title": "Create Constants", + "description": "Create deployment constants.", + "type": "Template", + "parameters": {}, + "startTime": "2019-10-15T19:29:22.7017314Z", + "endTime": "2019-10-15T19:29:56.6348495Z", + "outputs": { + "vault": { + "name": "null-provider-vault", + "id": "/subscriptions/ca13578c-6d3b-4478-b63e-a65c89601d86/resourceGroups/Microsoft.NullProvider/providers/Microsoft.KeyVault/vaults/null-provider-vault" + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json new file mode 100644 index 000000000000..66908fa86cf1 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "fileContainerId": "Microsoft.NullProvider.1.1", + "fileContainerParameters": { + "properties": { + "sourceUri": "https://deploymentproviderbvts.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/temp/Microsoft.NullProvider.1.1.zip", + "postCopyAction": "Unzip" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/fileContainers", + "location": "global", + "properties": { + "postCopyAction": "Unzip", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Delete.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Delete.json new file mode 100644 index 000000000000..7ee403600e6d --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "fileContainerId": "Microsoft.NullProvider.1.1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Get.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Get.json new file mode 100644 index 000000000000..1825d47eb2a0 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "fileContainerId": "Microsoft.NullProvider.1.1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/fileContainers", + "location": "global", + "properties": { + "postCopyAction": "Unzip", + "uri": "https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/", + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/List.json new file mode 100644 index 000000000000..7516a854589b --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/fileContainers", + "location": "global", + "properties": { + "postCopyAction": "Unzip", + "uri": "https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/Operations/List.json new file mode 100644 index 000000000000..6a927b325599 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/Operations/List.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Deployment.Admin/locations/fileContainers/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "File Container", + "operation": "List/Get File Container(s)", + "description": "Returns the list of file containers or gets properties for the specified file container." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/fileContainers/write", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "File Container", + "operation": "Create/Update File Container", + "description": "Creates or updates a file container." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/fileContainers/delete", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "File Container", + "operation": "Delete File Container", + "description": "Deletes an existing file container." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/operationresults/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Operation Result", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Deployment.Admin/Operations/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Operation", + "operation": "List Supported Operations", + "description": "Returns the list of supported operations." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Deployment", + "operation": "List/Get Product Deployment(s)", + "description": "Returns the list of product deployments or gets properties for the specified product deployment." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/bootstrap/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Deployment", + "operation": "Execute Bootstrap Deployment Phase", + "description": "Executes 'bootstrap' deployment phase." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/deploy/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Deployment", + "operation": "Execute Provision Deployment Phase", + "description": "Executes 'provision' deployment phase." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/remove/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Deployment", + "operation": "Remove Installed Product", + "description": "Removes installed product." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/setexternalaccess/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Deployment", + "operation": "Set External Access", + "description": "Enables or disables operator's access to product subscription." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/secrets/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Secret", + "operation": "List/Get Secret(s)", + "description": "Returns the list of secrets or gets properties for the specified secret." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/secrets/import/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Secret", + "operation": "Import Secret Value", + "description": "Imports a new secret value." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productDeployments/secrets/validateImport/action", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Secret", + "operation": "Validate Import", + "description": "Validates input for the import action." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productPackages/read", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Package", + "operation": "List/Get Product Package(s)", + "description": "Returns the list of product packages or gets properties for the specified product package." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productPackages/write", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Package", + "operation": "Create/Update Product Package", + "description": "Creates or updates a product package." + } + }, + { + "name": "Microsoft.Deployment.Admin/locations/productPackages/delete", + "display": { + "provider": "Microsoft Deployment Provider", + "resource": "Product Package", + "operation": "Delete Product Package", + "description": "Deletes an existing product package." + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Bootstrap.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Bootstrap.json new file mode 100644 index 000000000000..1231430f0a43 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Bootstrap.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview", + "bootstrapActionParameter": { + "version": "1.0.2" + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Deploy.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Deploy.json new file mode 100644 index 000000000000..47466509160e --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Deploy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview", + "deployActionParameter": { + "version": "1.0.2" + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Get.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Get.json new file mode 100644 index 000000000000..260d2b3f837e --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/microsoft.iothubpreview", + "name": "global/microsoft.iothubpreview", + "type": "Microsoft.Deployment.Admin/locations/productDeployments", + "properties": { + "status": "BootstrapSucceeded", + "subscriptionId": "c487a9cf-9841-44fa-9370-7b9e094db57e", + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/List.json new file mode 100644 index 000000000000..d505ca50cf2e --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/microsoft.iothubpreview", + "name": "global/microsoft.iothubpreview", + "type": "Microsoft.Deployment.Admin/locations/productDeployments", + "properties": { + "status": "None", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/productDeployments/microsoft.eventhubstaging", + "name": "global/microsoft.eventhubstaging", + "type": "Microsoft.Deployment.Admin/locations/productDeployments", + "properties": { + "status": "DeploymentSucceeded", + "subscriptionId": "bc070a98-3728-476c-aeb0-8957e067c29d", + "deployment": { + "version": "1.3.1", + "actionPlanInstanceResourceId": "/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/actionplans/33a10be1-2365-44a9-8c69-c8a06e8fd81c", + "parameters": {} + }, + "lastSuccessfulDeployment": { + "version": "1.3.1", + "actionPlanInstanceResourceId": "/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/actionplans/33a10be1-2365-44a9-8c69-c8a06e8fd81c", + "parameters": {} + }, + "provisioningState": "Succeeded" + } + } + ] + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Lock.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Lock.json new file mode 100644 index 000000000000..2f0b39fa1bb4 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Lock.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Remove.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Remove.json new file mode 100644 index 000000000000..05fdceedfbb6 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Remove.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/RotateSecrets.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/RotateSecrets.json new file mode 100644 index 000000000000..05fdceedfbb6 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/RotateSecrets.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Unlock.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Unlock.json new file mode 100644 index 000000000000..648670de33b3 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductDeployment/Unlock.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview", + "unlockActionParameter": { + "duration": "P5D" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Create.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Create.json new file mode 100644 index 000000000000..b3439f9c6e71 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.NullProvider.1.1", + "fileContainerParameter": { + "properties": { + "fileContainerId": "Microsoft.NullProvider.1.1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/productPackages", + "properties": { + "fileContainerId": "Microsoft.NullProvider.1.1", + "isDeployable": true, + "isUpdatable": true, + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Delete.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Delete.json new file mode 100644 index 000000000000..106199cd1975 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.NullProvider.1.1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Get.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Get.json new file mode 100644 index 000000000000..593f444612a6 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.NullProvider.1.1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/productPackages", + "properties": { + "fileContainerId": "Microsoft.NullProvider.1.1", + "isDeployable": true, + "isUpdatable": true, + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/List.json new file mode 100644 index 000000000000..6138961357d4 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductPackage/List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "be8b2e19-7f92-4644-b808-a18283aebb01", + "location": "global", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1", + "name": "global/Microsoft.NullProvider.1.1", + "type": "Microsoft.Deployment.Admin/locations/productPackages", + "properties": { + "fileContainerId": "Microsoft.NullProvider.1.1", + "isDeployable": true, + "isUpdatable": true, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Get.Json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Get.Json new file mode 100644 index 000000000000..b6c83ec44937 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Get.Json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "secretName": "secretName", + "secretValue": "sslCert" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.IotHubPreview.1.0.2/secrets/sslCert", + "name": "global/Microsoft.IotHubPreview.1.0.2/sslCert", + "type": "Microsoft.Deployment.Admin/locations/productPackages/secrets", + "properties": { + "secretKind": "Certificate", + "description": "Application SSL certificate.", + "expiresAfter": "P365D", + "secretDescriptor": { + "keyLength": 3072, + "alternativeDnsNames": [] + }, + "secretState": { + "status": "NotUploaded", + "rotationStatus": "None" + }, + "provisioningState": "Succeeded" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Import.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Import.json new file mode 100644 index 000000000000..bf7340c44ac4 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Import.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "secretName": "secretName", + "secretParameters": { + "properties": { + "secretValue": "sslCert" + } + }, + "newOffer": { + "properties": { + "password": "password", + "data": "MIIasdajCasdadIIKlDCCCpAGCyqGSIb3DQEMCgECoIIJfjCCCXowHAYKKoZIhvcNAQwBAzAOBAg8H9AO2t5mSwICB9AEgglYZET8GdClyLmngkqx8gob6P56kmMBIB72BG9BZtjnCpY/D4E9Rhl2hmxHFPY2ivsRSgFKDg8tVs+hnMuokWShJhZ0oIaBo4nHRcKk4sWzCfgEN21T2tgCnkG+Fz2kpvv485YaRpnU+vRU19NfwOe34A+zxI63H7V8cnAOuy5fI7MPqWYFDYLAWtJwVbslLVBDmdyKTah7+53g4P71wZD3rupW/ntOJQUzmZUV5RXphIyQn1pN15DCLRPwgc0FwqglrUJMxHD/MJ8w23JXG9HcgVS7tCEDEVGs2X7P/svcy8zV14Amhy73Lcqy7ZS8lxlyvyuXMCbRmY9UxsGc3SvbgWZqVzWaaHbiq/8jEncq0Cd21I0Ynv3cGBwGR9ERml3NNeZWon1NFUxkZhG2CQ5z6W4NhnVX3iq9D1lklRbzYls8qcCKTIsT6qPbBonAKFBZ9+JqJxZSkzoiWVR3GqTdGaaSrY56g2WKwQ330/rJXSR2iaeWc/V+JXRz0GJ9bIrgqrFXunmyVJ6zXftu9sfFz/PTD9exbHVlYItzxxMTuCIfeHs6Neb4s1IP8JKEGHfmldoFOoInwL2NW7Q6EERLmvAZ600JTsD5lyDum8ne4J9yzCP09Qoruo7TtoFPE+CBqbb3hUVfT/kDp8EbqseWG6fyydXwI49VGwX5xUfO8qNW56tpjPZWg6wx4zLfkqxkEu3/+4/2IWtyAfFp6L0VdpyCFwJ0dcWJUI13WujHOobfjPWJ+atdXR4qbZ6QpKeotYKq+twmZXIkgSvWxkg/QR1j1wf+PMFnVoexPiqH0rxMS+VcLLUA/fXfrBaD/Q/0ZPChLOM9rBBN0tb6Kj09jlFKrqm0PsqPsXg9j1PwH5h0Ou6aaJ0GKj5LFAESeKp8FloBq5GXzROokjMjxoXN0S1KY/zgl+J57ZzNO21MGjXTE1jmHnCGKgMSoX+myE75o46FcvFrgdxWjR0XvAjCJdF0dnMk/HCxtTHxd0U5qhsIX9chZBW83mPMHhxmPPa/V5t+3YL0v2EOmsXtb3tVi3KlMwxNQKdNgbX4OFRY27crgLTzEhwgCXhwwsHayu/R7pBYCO6czJuSxGo5xdqWeF0wewZ4+bEzGfsAkY0sXMSelz48ehtVLaiEcWNYAVvRwV5AyBfXtPBBpZa8XMROXIlFDAFHVDQ7F+r6PlbZVT9z3ziAF+CeCCEFAsT86MMPHHtCr+ljAq4ZOGR2SgsY0idcETdSfZNpC+D2JF1g98niQOk7Gws1SeWf4mLRTQTSGBGTO/CONYaGo+H5erMF9uzRd3IuqmI6rjG0Upvl4hBu8bT+Kyy/5fHRDMwF8cc2IKCFHoPuTE/u6m0VSWGuR+WnAjem+McqxmWiqWgsfLKlfs9YzxbLLvBpPTDcUZgz16BB//Az9gRT/6dtwgSZ5U0zyq4+xED+LImQ3IJXfReaas5QS0b2JAeR1EcNio6221xh78+S5K2B7+LAhMRxGn2l4NZTYatugZimjp1vJK/pHo1Ph0ILpd5DwSmQMmnvDVIgttDnsMiYkL0voQNriDeGupqgxsh3Y7fOh8EqySr63XYhkYSM/BzuUFkdnc0hkMEd96p1OhjjJ8n1+FUuHjMGYMTaZyHCHB9+wLIQUiz1Y328B2qHN2vAKnA5vcx+Y+30rc3PM1Gu0zMJDB17bsLrpNZHQ0e7bzekKdVY27bbRjDX/ZfSmEt5Iq24ilcbL3WBFChwBesDRrnFHkxNJUR+suVTlaX80axjOABtJxfSJ9xEa1orA9I1d5hlRVWGgRXsOM1u9rKauCGKZ4jdl1pfIVSUyT5N1HBUvmfn4Nau/+AsgBy4+cbVVd77gbdAt+YXp7EYF665SlipcvDzmcLp9WsCasYeNbQ9l4G4Vh8dzyuJZuJSrOe/Ue7pQgLRSZx58NLGvy2HhZ6h9i+z7967iPhUrkMb/gGorof2qCtB9VgP8Kg7VV1rym9suFj41zS0CE3BGjwFK4zvIrFKB4zH//qZdEG366zA145hWOnFWVqF88YAuZTJ2JWGoIiq5SZ8wZfOQRVAK4rdDlKVT2+wCr2mAK0xU8r2ln61xsQq7OvYi4iNvMkFcV9Y5afoHoCQdtvURN3Oipoi8om+iNOm2TDx8YtLEvWYWzOEmYHGOmfAs9wSCSI5xcW9tBPBsVCxympFcsW4tMx34sPAS8PzzkymFiUy+HMtuhyvTzQ5paqgQkelvbh3Re1hGEmHSaOn7y9vRUOMfQyGTA89ohUVYkfrOvDh+aUtWlcd7SCMeUOevE46YJJY/TzGEr4XBrfVoMI1S0oiRLvfnI8B2II06Y9Ae0zj2zQTUuIZj+8go3N6ClDFe8+C03cC6xTvnTlf33VWZzv0t33xGmVDYgQpC+cV99AJb7jS1Zkk+Ed2K79IeLAKWIydqkmRqPKuncEEYL54BGgHJqw5k/gtyAEjoqUBcsI9mUpjLSXXXRq04J41TkBEkSyMqeb9zNeuH23pLqF3k/LZxIQ6VFpZeX0DDHZfqR9DhX+7V7wuPqpiNiCnWbhDyr4RjtKSpuKnfzWgAjnkaUXaNCwyogBnV+fpt8klZSDvnyuZMQGr8rIy+P/rpWCOAkU6pvumVwNk+1CE8x0GSzWx6BoC/8ieeEv0maZnBBARe/07i+rNETbKh9YaSK5YLCer1KQeoHrFoyaka44ngYjo09X5dJlZutmsPm46Up0n1PAeqLxQbSUxiT1leaS3DiWmUaPAUFYkVKWYvlNG6jk70+ei2ivAGmcID6yQFfQRF5t/v71U2qSSKBPfsFXH69xw/UY1ivjZ2EASRG9u45bWLPhOOMQ5ilSb80nPcGHSIpz0gayGUhIgTJhOue13HnjIfmbo0pE2yECggQmvMO/833FStNzI7MG6nsiryFAShuMDPG89C4kjA0f07Q6agUtpJgHCZfHOMnKYOwO6h8QC5woNjKxhQl7cZFpPEE7xCEicmAmP3A4wS46S7MA0rGagU1AGCUUOVad62PEBsghReVkRsEelIG2NOYTyuIGXgcsQBvdNmnhtHTdIgQ6ycxR7IOmJIzN50kBx32xN+IfaLh37oAIrM/+dD9KxzrQCghtrEiGQeDdEI25rHIdtE3dwhWSEZ1fl/6B21S6Yh13YDOWpVnhgdX/9w+mdXD+mQjWxmK9ZdptgTaCoiro45zGB/jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADYANwBiADQAYwAzAGIAMQAtADcANwBiAGQALQA0ADYAMwAxAC0AYgBhADQAYwAtADMAZABkADIANAAwAGIAMgA0ADIANQA1MHkGCSsGAQQBgjcRATFsHmoATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABSAFMAQQAgAGEAbgBkACAAQQBFAFMAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByMIIMfwYJKoZIhvcNAQcGoIIMcDCCDGwCAQAwggxlBgkqhkiG9w0BBwEwHAYKKoZIhvcNAQwBAzAOBAgK726i3z4NuwICB9CAggw4LOMv7g2Y9P0912i5nlJpTiX9mjGTJyl5WDiCtLy1Ik23TOKlRpXahQ8bPGAxR2ebCgVHL3iTStiiu3Wb3V93ZUmWo9aY84BTN2PJsF8O5m2OvpY08DZUOD4F0pLfkUv7lUBGjdYmRDh7SJLFQztENdji511bz1nfonfcTgIlYou5cAhitb/bp7NHbCsCugPKXd0yG1y/jOKEQzQ7oKlPP92DgpA2VUqeQOm79FZA/F/SoH6bfwWa7tsC1uE40psgJqrQMYq7pZfSr9GFtKW1XiLvVbzAnvyn+SH2AA85W1c2w8sh4NEiLajY3NPX+jStly9N0i2Yepn493dg/Wk553FLVa+QrP62C766yyjDPkYhCbBQowB0oiH0drykL7wRbYaTtfcC9N2GdENT6SrBZfdqO0wjLTHfbpxnB2cI0ziWCsTyX1OQPrvZYmRXeeoQ569uOBGT2xXi6BSrMRDIJxyO/M/qTvLsoroB2MoCkF4t9/XZYdCDaIxSMxauQ9bHUBEkJz7srfn6OxU/2Z/PysX3sOQS5JJqeat8ryCG5MTJz69QLqDUTutBSOJ8isXC3TcjjYWzxO0jc3PmmmGIqX0D5ZLeURG1ePrkxSPKHNbMYtg/lvDNSZ6R35ApQ7EDXUVZSmlJFDnxPYjuwo9JV6W0AZMekKGdUJMOtwAy0BekBDuTAnzHRbe4QxNCbjDQXbtvOcZ1Q1DRekJtPPM20clucthlTHBgFRtoEFoIcLunY/jbpxrsjMeuKp+iuxnDVHhxxJLdtF/4WI9OKNC6sPGpqhQjGujzg+bCzYn6tuxqf5zgsEiSpqwoxIQLQ/yPJr1UXOWf6NY8AAkBjQ59ExisFGhtg88HgwC9QkMpxWBU0UOnrx7twBwlWNIVjt4yR5UMiMNOIcemZukt7GeXojcpti/mtzbaLOjCB25C6fZBBUJS7hYE3WZ+fMgyUIf1f1VqCdbVBclrduAdx9BqSCPMpjmtKN5MZewc/CNqrm8sPmjYiWI5LC1vh4dbcSpd6Pl76YV3vxPWn3cZTeDwLSU2lX7lVqS3jrj0NF8/VkVR8iS13u6baAIRN6UZNOSLwcalB/eZkRSYHqSTE4Cnh1O+qkoTX/PGYm1BIv5NKGnSJjc6+/vD3xMAIxYr4FbdCZ+VDIVRb0iAhC8hArHXjU6vHL8EAQYxeC8t5JcvfmmaDTkaymVKJz+6mNKSUhLDHJIo1h8Y4a/oVwL+bLPO8HwYQyLxVMwQLeEOc0isB1i62Kygwf+Pvg2xRgcuNwXRarsFQj+wkj0b+8vTyWVS8hTUWi9LkB95sNBwBwCKaHU6lbQBjUCApiV23F3ssJISR8nDuIgRWFYjNU8tUk4lCy0zeM0v9JzbbWm7vGfURx5CPxo4h1PL/Cw+l3QO9qG+FmawLNfF4wO3I/DaSd8aav60r7+mdj6WIcv6F5+MlFMW11kIlBwEh44umhVpzUpSFt8tI3oJ/TTzxdOgXJTg4uZk1ljOd1tXgvKG9+EpFGcFVbcm3ikljcMRY1neXFUV2p9A8tfTCFigB+j+zCQJXPDQlsgdgnBk6uwm4c7vxIEIU+ZMpv+Q2BhP69+W5RpXUo4431R5/bM8mVAmSPvMBSKYh2uZSEhGt/7rC3z61zmYGjSj8RFStBQG/Y82ZVmdFSKz+YYj/wljs1YZo2XghFfTgT/CdZyNWhLO+nHL2H9h0Po4TN5fHXsrfsyFfzIcxjfc+3iCw+Nw0IghSBDFaAkX3jV8ZF9o23vo3AopM8W+2qscnTe+wMSdrME/h7EvvnpMTBnZIpjyFw2vXoOSjitWijvbomDzyHXBwfoKqHquhPLIx7ub0xG6FhxWeKNMfxhJ0/W0Z7iHKGRXH55s05Wd3wjwnghQfFdAjftkcFEkEQIQ3xLzd1QEaRgMbYZEQkH9PYitiIbNmURaZlY5jJZwL5itouaZhsaMoPsego1e0UQfij1bUpJcFL6L4VI5eokeeAtfGguLtaKxkPuHWeWnrErnXWbI7rqFkq5fkESZSv+IaGUYZGRJ1ybpgrH6Ik7Mvi9L3kBCs6dZg6ACkDgq98kpazOCjk0JWuTHaoekTr26NBglfKWdPWke2qvKEuq9baMUkB05+PlC29TW6tvrucRiX1pO9xQjipZ7c6yF8sel/msn3Xj5EB78yPjWZjrwPst3fkFcC1kiBxSPovefaxChjG+u5nP5jbV1NGiQBk/OdIYggel74VkYQ4DANo4D+rs0s6UnzBbsMEe+qxt7ztM7AUAIXfmz0T+XD+pT5Qwv5pE/wuysSLk5KKXw/bFLRORJbzY1f03wKKlTaD7jFVbCJgy7lj2fc+sUCGdaUxmiczJc58n1RK/sqccRNQrnPyi5YYrYZ8EdvwqkHwMSIvZjT0hPw+/ooOLjN8TNPtYRnm3DDN3KN2S8iaHQOxokBD1SWzGN/v1d19+kYcG2aayosqHcr7XcAc5aQKT+M8YdZwgcTu+NsTz5o3YIG4+xIphdjiWAGWKIvlhiXDnVi5zNPt/YqnNE0Vl5mVMaPnKs31PQzErzFeF80ZQ/gSPflWadLLMcoZV3Q8VNGbcmQHuOpdS/rEBGDWE9jRGcC3i+V7CKpzt7ehNLq9b5CdX5qvkfoci/4iDNjXsR8qEMdlKjSD8H9PH7j0JP476El0TaqiuVApv+X/S10x8au086wnKu2L4dzMu9O2VV4qx1xFZI0SAD/JCVYddApkpGAweEMRHoEWqwcBwIsF2mYPmTRaU29Z4laCCMA1uCMMFcL4tM57XlptxFsZgNrWbFJdnOh0KM6TGAeXq9j6h3g0A4PaqfNAOaG5HWQBlOf5KmviO5EtcfslfL0XaS65E+fK8RoOpj0Um6b069R1NwrHy4/YdJZQFUt5EJFKa+m0MvdFxiIeiNIYhG+POH0l+6ycVz4u4nKplh0jmskj2kyNy+65TX4Y1Gg5dKVSQWfG2c5Tuim1UBB/51cS1cgS73SbdEe136kCuUg5Cc0/jm0RCS31DW/GLtrdGtgOcmPNrAk7HomiD6nHvV1yb/ghgyGKRIMmQEMOfn2ul/51Lo0sPSP++1KJKfEkqJFnjYWrmRR2x0rEf/3juYlN4GXO0YTNtfyou3DBI/mpdpHgiR1/jXKWe+h9wMWyVZt4goyQifTYSs+3L7Bx3EsrjhZQzoe/lQTywtkvLIeq5zOkRK2EPkDPjLPbD4nqp+mzQg74Y7ZGWy7DBlU97TdYyFIossYnpNxbRPodJ/xqtB5IPvCjp6uoUwRJyPNBCUCJyanVlN7R2Tju5NszpwhnN3xtcUbvA45M/b2lV4RBh6pnLi/ktajwBo331edlI4q91AGxuJvxugwPYiudkiSWnZc7LxwOPiwExivuq7Era85mci9URRnBb+EYMA4RqnFrs327POeytuMmNtGAESRA1NwlRJOTLplO7suJmnDT9A0mOfUmnkcyzah3khqCucl96w9mINmbcEoOBGp1xVske2TGhFSsDCObae0BvF2f+43ciwbxDpGTuNB9UnV8w41HV2UhZ+OjYJK0pgVlk5+vfnXEw+iJiPItSynB1HZsdqLJuEqRESRVRIozqR/bHSkv61y2Bq5isT9ZwF9FNbZuSgGoLAvuzpwN95Mx83g4MsNvYWo9EyIEGvjbecBzL9fpeunkvrD2LC8k8+sdtQQ5rPibMKV6kL6ThWbeDhXExk0vZcHos3nLBLsW5Ov/J2erN/CcJdd/CGnwzxMjfmbp2FxLFMwe4XdMsBp7WlGjMy++hRbINtwMAysboIb/YOTOylgBNSDl6uJ27MHtbLhgSyDEw18bFglqWvjvKUJKPbZE7bEw9w3HgWojsQavaqewuAp9OYyg4ZfQCApNmSievlt673v0nZ5dooS9rZroDukwIwTQpxmWaS0wo7SWkkRy99Owe08PFEsM93FrtuyTNz4+1sAWWkQrU7eU5l5C+NM9ZUhCe7jTxTBAs+VMHdMVRF5FQKPLM5CU5RIfg7RDs94TSVPEB8gG5r13+Kmf5gv1NzX8QHmrRA1k0uzF9g4btWdXhoCarB61wFXsizx3mTFEmYev5A3vb6Dn6E4Md//+gJFJ31DcmK7I1DvJCM8QV1mKQydZTef5GkrPxxCk4/kK6cbSNpaHwgNZRPoq+2q9+ZBGK8dzvWbOUwOzAfMAcGBSsOAwIaBBQYe7dTefP7Lx9vu5M0PY3co6yQXwQUiMIUs1ICQSCmLpbiC0DEBnr1JxYCAgfQ" + } + } + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/List.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/List.json new file mode 100644 index 000000000000..cc35a2b5b53a --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/List.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "secretValue": "sslCert" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/AdHoc", + "name": "global/Microsoft.NullProvider.1.1/AdHoc", + "type": "Microsoft.Deployment.Admin/locations/productPackages/secrets", + "properties": { + "secretKind": "AdHoc", + "description": "This is an ad-hoc secret.", + "expiresAfter": "P365D", + "secretState": { + "status": "NotUploaded", + "rotationStatus": "None" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/TlsCertificate", + "name": "global/Microsoft.NullProvider.1.1/TlsCertificate", + "type": "Microsoft.Deployment.Admin/locations/productPackages/secrets", + "properties": { + "secretKind": "Certificate", + "description": "This is a TLS certificate.", + "expiresAfter": "P365D", + "secretDescriptor": { + "subject": "CN=NullProviderTLS", + "keyLength": 4096, + "alternativeDnsNames": [ + "noterp.redmond.ext-n22r1708.masd.stbtest.microsoft.com" + ] + }, + "secretState": { + "status": "NotUploaded", + "rotationStatus": "None" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/ExternalPassword", + "name": "global/Microsoft.NullProvider.1.1/ExternalPassword", + "type": "Microsoft.Deployment.Admin/locations/productPackages/secrets", + "properties": { + "secretKind": "Password", + "description": "This is an external password.", + "expiresAfter": "P365D", + "secretDescriptor": { + "passwordLength": 10, + "allowedCharacters": "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", + "passwordValidationRegex": "^(?=.*\\d)(?=.*[A-Z])(?=.*[a-z]).*$" + }, + "secretState": { + "status": "NotUploaded", + "rotationStatus": "None" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/ExternalSymmetricKey", + "name": "global/Microsoft.NullProvider.1.1/ExternalSymmetricKey", + "type": "Microsoft.Deployment.Admin/locations/productPackages/secrets", + "properties": { + "secretKind": "SymmetricKey", + "description": "This is an external symmetric key.", + "expiresAfter": "P365D", + "secretDescriptor": { + "keyLength": 128 + }, + "secretState": { + "status": "NotUploaded", + "rotationStatus": "None" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Validate.json b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Validate.json new file mode 100644 index 000000000000..09fc63e01e89 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ProductSecret/Validate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "global", + "api-version": "2019-01-01", + "productId": "Microsoft.IotHubPreview.1.0.2", + "secretName": "secretName", + "secretParameters": { + "properties": { + "secretValue": "sslCert" + } + }, + "secretValue": "sslCert", + "newOffer": { + "properties": { + "password": "password", + "data": "MIIasdajCasdadIIKlDCCCpAGCyqGSIb3DQEMCgECoIIJfjCCCXowHAYKKoZIhvcNAQwBAzAOBAg8H9AO2t5mSwICB9AEgglYZET8GdClyLmngkqx8gob6P56kmMBIB72BG9BZtjnCpY/D4E9Rhl2hmxHFPY2ivsRSgFKDg8tVs+hnMuokWShJhZ0oIaBo4nHRcKk4sWzCfgEN21T2tgCnkG+Fz2kpvv485YaRpnU+vRU19NfwOe34A+zxI63H7V8cnAOuy5fI7MPqWYFDYLAWtJwVbslLVBDmdyKTah7+53g4P71wZD3rupW/ntOJQUzmZUV5RXphIyQn1pN15DCLRPwgc0FwqglrUJMxHD/MJ8w23JXG9HcgVS7tCEDEVGs2X7P/svcy8zV14Amhy73Lcqy7ZS8lxlyvyuXMCbRmY9UxsGc3SvbgWZqVzWaaHbiq/8jEncq0Cd21I0Ynv3cGBwGR9ERml3NNeZWon1NFUxkZhG2CQ5z6W4NhnVX3iq9D1lklRbzYls8qcCKTIsT6qPbBonAKFBZ9+JqJxZSkzoiWVR3GqTdGaaSrY56g2WKwQ330/rJXSR2iaeWc/V+JXRz0GJ9bIrgqrFXunmyVJ6zXftu9sfFz/PTD9exbHVlYItzxxMTuCIfeHs6Neb4s1IP8JKEGHfmldoFOoInwL2NW7Q6EERLmvAZ600JTsD5lyDum8ne4J9yzCP09Qoruo7TtoFPE+CBqbb3hUVfT/kDp8EbqseWG6fyydXwI49VGwX5xUfO8qNW56tpjPZWg6wx4zLfkqxkEu3/+4/2IWtyAfFp6L0VdpyCFwJ0dcWJUI13WujHOobfjPWJ+atdXR4qbZ6QpKeotYKq+twmZXIkgSvWxkg/QR1j1wf+PMFnVoexPiqH0rxMS+VcLLUA/fXfrBaD/Q/0ZPChLOM9rBBN0tb6Kj09jlFKrqm0PsqPsXg9j1PwH5h0Ou6aaJ0GKj5LFAESeKp8FloBq5GXzROokjMjxoXN0S1KY/zgl+J57ZzNO21MGjXTE1jmHnCGKgMSoX+myE75o46FcvFrgdxWjR0XvAjCJdF0dnMk/HCxtTHxd0U5qhsIX9chZBW83mPMHhxmPPa/V5t+3YL0v2EOmsXtb3tVi3KlMwxNQKdNgbX4OFRY27crgLTzEhwgCXhwwsHayu/R7pBYCO6czJuSxGo5xdqWeF0wewZ4+bEzGfsAkY0sXMSelz48ehtVLaiEcWNYAVvRwV5AyBfXtPBBpZa8XMROXIlFDAFHVDQ7F+r6PlbZVT9z3ziAF+CeCCEFAsT86MMPHHtCr+ljAq4ZOGR2SgsY0idcETdSfZNpC+D2JF1g98niQOk7Gws1SeWf4mLRTQTSGBGTO/CONYaGo+H5erMF9uzRd3IuqmI6rjG0Upvl4hBu8bT+Kyy/5fHRDMwF8cc2IKCFHoPuTE/u6m0VSWGuR+WnAjem+McqxmWiqWgsfLKlfs9YzxbLLvBpPTDcUZgz16BB//Az9gRT/6dtwgSZ5U0zyq4+xED+LImQ3IJXfReaas5QS0b2JAeR1EcNio6221xh78+S5K2B7+LAhMRxGn2l4NZTYatugZimjp1vJK/pHo1Ph0ILpd5DwSmQMmnvDVIgttDnsMiYkL0voQNriDeGupqgxsh3Y7fOh8EqySr63XYhkYSM/BzuUFkdnc0hkMEd96p1OhjjJ8n1+FUuHjMGYMTaZyHCHB9+wLIQUiz1Y328B2qHN2vAKnA5vcx+Y+30rc3PM1Gu0zMJDB17bsLrpNZHQ0e7bzekKdVY27bbRjDX/ZfSmEt5Iq24ilcbL3WBFChwBesDRrnFHkxNJUR+suVTlaX80axjOABtJxfSJ9xEa1orA9I1d5hlRVWGgRXsOM1u9rKauCGKZ4jdl1pfIVSUyT5N1HBUvmfn4Nau/+AsgBy4+cbVVd77gbdAt+YXp7EYF665SlipcvDzmcLp9WsCasYeNbQ9l4G4Vh8dzyuJZuJSrOe/Ue7pQgLRSZx58NLGvy2HhZ6h9i+z7967iPhUrkMb/gGorof2qCtB9VgP8Kg7VV1rym9suFj41zS0CE3BGjwFK4zvIrFKB4zH//qZdEG366zA145hWOnFWVqF88YAuZTJ2JWGoIiq5SZ8wZfOQRVAK4rdDlKVT2+wCr2mAK0xU8r2ln61xsQq7OvYi4iNvMkFcV9Y5afoHoCQdtvURN3Oipoi8om+iNOm2TDx8YtLEvWYWzOEmYHGOmfAs9wSCSI5xcW9tBPBsVCxympFcsW4tMx34sPAS8PzzkymFiUy+HMtuhyvTzQ5paqgQkelvbh3Re1hGEmHSaOn7y9vRUOMfQyGTA89ohUVYkfrOvDh+aUtWlcd7SCMeUOevE46YJJY/TzGEr4XBrfVoMI1S0oiRLvfnI8B2II06Y9Ae0zj2zQTUuIZj+8go3N6ClDFe8+C03cC6xTvnTlf33VWZzv0t33xGmVDYgQpC+cV99AJb7jS1Zkk+Ed2K79IeLAKWIydqkmRqPKuncEEYL54BGgHJqw5k/gtyAEjoqUBcsI9mUpjLSXXXRq04J41TkBEkSyMqeb9zNeuH23pLqF3k/LZxIQ6VFpZeX0DDHZfqR9DhX+7V7wuPqpiNiCnWbhDyr4RjtKSpuKnfzWgAjnkaUXaNCwyogBnV+fpt8klZSDvnyuZMQGr8rIy+P/rpWCOAkU6pvumVwNk+1CE8x0GSzWx6BoC/8ieeEv0maZnBBARe/07i+rNETbKh9YaSK5YLCer1KQeoHrFoyaka44ngYjo09X5dJlZutmsPm46Up0n1PAeqLxQbSUxiT1leaS3DiWmUaPAUFYkVKWYvlNG6jk70+ei2ivAGmcID6yQFfQRF5t/v71U2qSSKBPfsFXH69xw/UY1ivjZ2EASRG9u45bWLPhOOMQ5ilSb80nPcGHSIpz0gayGUhIgTJhOue13HnjIfmbo0pE2yECggQmvMO/833FStNzI7MG6nsiryFAShuMDPG89C4kjA0f07Q6agUtpJgHCZfHOMnKYOwO6h8QC5woNjKxhQl7cZFpPEE7xCEicmAmP3A4wS46S7MA0rGagU1AGCUUOVad62PEBsghReVkRsEelIG2NOYTyuIGXgcsQBvdNmnhtHTdIgQ6ycxR7IOmJIzN50kBx32xN+IfaLh37oAIrM/+dD9KxzrQCghtrEiGQeDdEI25rHIdtE3dwhWSEZ1fl/6B21S6Yh13YDOWpVnhgdX/9w+mdXD+mQjWxmK9ZdptgTaCoiro45zGB/jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADYANwBiADQAYwAzAGIAMQAtADcANwBiAGQALQA0ADYAMwAxAC0AYgBhADQAYwAtADMAZABkADIANAAwAGIAMgA0ADIANQA1MHkGCSsGAQQBgjcRATFsHmoATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABSAFMAQQAgAGEAbgBkACAAQQBFAFMAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByMIIMfwYJKoZIhvcNAQcGoIIMcDCCDGwCAQAwggxlBgkqhkiG9w0BBwEwHAYKKoZIhvcNAQwBAzAOBAgK726i3z4NuwICB9CAggw4LOMv7g2Y9P0912i5nlJpTiX9mjGTJyl5WDiCtLy1Ik23TOKlRpXahQ8bPGAxR2ebCgVHL3iTStiiu3Wb3V93ZUmWo9aY84BTN2PJsF8O5m2OvpY08DZUOD4F0pLfkUv7lUBGjdYmRDh7SJLFQztENdji511bz1nfonfcTgIlYou5cAhitb/bp7NHbCsCugPKXd0yG1y/jOKEQzQ7oKlPP92DgpA2VUqeQOm79FZA/F/SoH6bfwWa7tsC1uE40psgJqrQMYq7pZfSr9GFtKW1XiLvVbzAnvyn+SH2AA85W1c2w8sh4NEiLajY3NPX+jStly9N0i2Yepn493dg/Wk553FLVa+QrP62C766yyjDPkYhCbBQowB0oiH0drykL7wRbYaTtfcC9N2GdENT6SrBZfdqO0wjLTHfbpxnB2cI0ziWCsTyX1OQPrvZYmRXeeoQ569uOBGT2xXi6BSrMRDIJxyO/M/qTvLsoroB2MoCkF4t9/XZYdCDaIxSMxauQ9bHUBEkJz7srfn6OxU/2Z/PysX3sOQS5JJqeat8ryCG5MTJz69QLqDUTutBSOJ8isXC3TcjjYWzxO0jc3PmmmGIqX0D5ZLeURG1ePrkxSPKHNbMYtg/lvDNSZ6R35ApQ7EDXUVZSmlJFDnxPYjuwo9JV6W0AZMekKGdUJMOtwAy0BekBDuTAnzHRbe4QxNCbjDQXbtvOcZ1Q1DRekJtPPM20clucthlTHBgFRtoEFoIcLunY/jbpxrsjMeuKp+iuxnDVHhxxJLdtF/4WI9OKNC6sPGpqhQjGujzg+bCzYn6tuxqf5zgsEiSpqwoxIQLQ/yPJr1UXOWf6NY8AAkBjQ59ExisFGhtg88HgwC9QkMpxWBU0UOnrx7twBwlWNIVjt4yR5UMiMNOIcemZukt7GeXojcpti/mtzbaLOjCB25C6fZBBUJS7hYE3WZ+fMgyUIf1f1VqCdbVBclrduAdx9BqSCPMpjmtKN5MZewc/CNqrm8sPmjYiWI5LC1vh4dbcSpd6Pl76YV3vxPWn3cZTeDwLSU2lX7lVqS3jrj0NF8/VkVR8iS13u6baAIRN6UZNOSLwcalB/eZkRSYHqSTE4Cnh1O+qkoTX/PGYm1BIv5NKGnSJjc6+/vD3xMAIxYr4FbdCZ+VDIVRb0iAhC8hArHXjU6vHL8EAQYxeC8t5JcvfmmaDTkaymVKJz+6mNKSUhLDHJIo1h8Y4a/oVwL+bLPO8HwYQyLxVMwQLeEOc0isB1i62Kygwf+Pvg2xRgcuNwXRarsFQj+wkj0b+8vTyWVS8hTUWi9LkB95sNBwBwCKaHU6lbQBjUCApiV23F3ssJISR8nDuIgRWFYjNU8tUk4lCy0zeM0v9JzbbWm7vGfURx5CPxo4h1PL/Cw+l3QO9qG+FmawLNfF4wO3I/DaSd8aav60r7+mdj6WIcv6F5+MlFMW11kIlBwEh44umhVpzUpSFt8tI3oJ/TTzxdOgXJTg4uZk1ljOd1tXgvKG9+EpFGcFVbcm3ikljcMRY1neXFUV2p9A8tfTCFigB+j+zCQJXPDQlsgdgnBk6uwm4c7vxIEIU+ZMpv+Q2BhP69+W5RpXUo4431R5/bM8mVAmSPvMBSKYh2uZSEhGt/7rC3z61zmYGjSj8RFStBQG/Y82ZVmdFSKz+YYj/wljs1YZo2XghFfTgT/CdZyNWhLO+nHL2H9h0Po4TN5fHXsrfsyFfzIcxjfc+3iCw+Nw0IghSBDFaAkX3jV8ZF9o23vo3AopM8W+2qscnTe+wMSdrME/h7EvvnpMTBnZIpjyFw2vXoOSjitWijvbomDzyHXBwfoKqHquhPLIx7ub0xG6FhxWeKNMfxhJ0/W0Z7iHKGRXH55s05Wd3wjwnghQfFdAjftkcFEkEQIQ3xLzd1QEaRgMbYZEQkH9PYitiIbNmURaZlY5jJZwL5itouaZhsaMoPsego1e0UQfij1bUpJcFL6L4VI5eokeeAtfGguLtaKxkPuHWeWnrErnXWbI7rqFkq5fkESZSv+IaGUYZGRJ1ybpgrH6Ik7Mvi9L3kBCs6dZg6ACkDgq98kpazOCjk0JWuTHaoekTr26NBglfKWdPWke2qvKEuq9baMUkB05+PlC29TW6tvrucRiX1pO9xQjipZ7c6yF8sel/msn3Xj5EB78yPjWZjrwPst3fkFcC1kiBxSPovefaxChjG+u5nP5jbV1NGiQBk/OdIYggel74VkYQ4DANo4D+rs0s6UnzBbsMEe+qxt7ztM7AUAIXfmz0T+XD+pT5Qwv5pE/wuysSLk5KKXw/bFLRORJbzY1f03wKKlTaD7jFVbCJgy7lj2fc+sUCGdaUxmiczJc58n1RK/sqccRNQrnPyi5YYrYZ8EdvwqkHwMSIvZjT0hPw+/ooOLjN8TNPtYRnm3DDN3KN2S8iaHQOxokBD1SWzGN/v1d19+kYcG2aayosqHcr7XcAc5aQKT+M8YdZwgcTu+NsTz5o3YIG4+xIphdjiWAGWKIvlhiXDnVi5zNPt/YqnNE0Vl5mVMaPnKs31PQzErzFeF80ZQ/gSPflWadLLMcoZV3Q8VNGbcmQHuOpdS/rEBGDWE9jRGcC3i+V7CKpzt7ehNLq9b5CdX5qvkfoci/4iDNjXsR8qEMdlKjSD8H9PH7j0JP476El0TaqiuVApv+X/S10x8au086wnKu2L4dzMu9O2VV4qx1xFZI0SAD/JCVYddApkpGAweEMRHoEWqwcBwIsF2mYPmTRaU29Z4laCCMA1uCMMFcL4tM57XlptxFsZgNrWbFJdnOh0KM6TGAeXq9j6h3g0A4PaqfNAOaG5HWQBlOf5KmviO5EtcfslfL0XaS65E+fK8RoOpj0Um6b069R1NwrHy4/YdJZQFUt5EJFKa+m0MvdFxiIeiNIYhG+POH0l+6ycVz4u4nKplh0jmskj2kyNy+65TX4Y1Gg5dKVSQWfG2c5Tuim1UBB/51cS1cgS73SbdEe136kCuUg5Cc0/jm0RCS31DW/GLtrdGtgOcmPNrAk7HomiD6nHvV1yb/ghgyGKRIMmQEMOfn2ul/51Lo0sPSP++1KJKfEkqJFnjYWrmRR2x0rEf/3juYlN4GXO0YTNtfyou3DBI/mpdpHgiR1/jXKWe+h9wMWyVZt4goyQifTYSs+3L7Bx3EsrjhZQzoe/lQTywtkvLIeq5zOkRK2EPkDPjLPbD4nqp+mzQg74Y7ZGWy7DBlU97TdYyFIossYnpNxbRPodJ/xqtB5IPvCjp6uoUwRJyPNBCUCJyanVlN7R2Tju5NszpwhnN3xtcUbvA45M/b2lV4RBh6pnLi/ktajwBo331edlI4q91AGxuJvxugwPYiudkiSWnZc7LxwOPiwExivuq7Era85mci9URRnBb+EYMA4RqnFrs327POeytuMmNtGAESRA1NwlRJOTLplO7suJmnDT9A0mOfUmnkcyzah3khqCucl96w9mINmbcEoOBGp1xVske2TGhFSsDCObae0BvF2f+43ciwbxDpGTuNB9UnV8w41HV2UhZ+OjYJK0pgVlk5+vfnXEw+iJiPItSynB1HZsdqLJuEqRESRVRIozqR/bHSkv61y2Bq5isT9ZwF9FNbZuSgGoLAvuzpwN95Mx83g4MsNvYWo9EyIEGvjbecBzL9fpeunkvrD2LC8k8+sdtQQ5rPibMKV6kL6ThWbeDhXExk0vZcHos3nLBLsW5Ov/J2erN/CcJdd/CGnwzxMjfmbp2FxLFMwe4XdMsBp7WlGjMy++hRbINtwMAysboIb/YOTOylgBNSDl6uJ27MHtbLhgSyDEw18bFglqWvjvKUJKPbZE7bEw9w3HgWojsQavaqewuAp9OYyg4ZfQCApNmSievlt673v0nZ5dooS9rZroDukwIwTQpxmWaS0wo7SWkkRy99Owe08PFEsM93FrtuyTNz4+1sAWWkQrU7eU5l5C+NM9ZUhCe7jTxTBAs+VMHdMVRF5FQKPLM5CU5RIfg7RDs94TSVPEB8gG5r13+Kmf5gv1NzX8QHmrRA1k0uzF9g4btWdXhoCarB61wFXsizx3mTFEmYev5A3vb6Dn6E4Md//+gJFJ31DcmK7I1DvJCM8QV1mKQydZTef5GkrPxxCk4/kK6cbSNpaHwgNZRPoq+2q9+ZBGK8dzvWbOUwOzAfMAcGBSsOAwIaBBQYe7dTefP7Lx9vu5M0PY3co6yQXwQUiMIUs1ICQSCmLpbiC0DEBnr1JxYCAgfQ" + } + } + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/deployment/readme.md b/specification/azsadmin/resource-manager/deployment/readme.md new file mode 100644 index 000000000000..0fd649383551 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/readme.md @@ -0,0 +1,88 @@ +# Deployment Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Deployment Admin. + +--- +## Getting Started +To build the SDK for Deployment Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for the Deployment Resource Provider API. + +``` yaml +title: DeploymentAdminClient +description: Deployment Admin Client +openapi-type: arm +tag: package-2019-01-01 +``` + +### Tag: package-2019-01-01 + +These settings apply only when `--tag=package-2019-01-01` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01-01' +input-file: + - Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json + - Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json +``` + +--- +# Code Generation + +## C# + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.AzureStack.Management.Deployment.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json index e71649dedcd7..d38b6a95054d 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json @@ -132,11 +132,11 @@ "description": "The deployment id of the stamp.", "type": "string" }, - "externalDsnIPAddress01": { + "externalDNSIPAddress01": { "description": "First external IP address of the DNS server.", "type": "string" }, - "externalDsnIPAddress02": { + "externalDNSIPAddress02": { "description": "Second external IP Address of the DNS server.", "type": "string" }, diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnit.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnit.json index 33d362fa0e25..b61bb0c6bbfb 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnit.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnit.json @@ -423,7 +423,7 @@ "x-ms-parameter-location": "method" }, "ScaleOutScaleUnitParametersInBody": { - "name": "nodeList", + "name": "scaleUnitNodeParameters", "description": "A list of input data that allows for adding a set of scale unit nodes.", "in": "body", "required": true, diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/ScaleUnit/ScaleOut.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/ScaleUnit/ScaleOut.json index 85691ca456d6..80503125961a 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/ScaleUnit/ScaleOut.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/ScaleUnit/ScaleOut.json @@ -5,7 +5,7 @@ "resourceGroupName": "System.local", "location": "local", "scaleUnit": "S-Cluster", - "nodeList": { + "scaleUnitNodeParameters": { "scaleUnitNode": "N1S2", "bmcIPv4Address": "192.0.0.1" } diff --git a/specification/azsadmin/resource-manager/fabric/readme.md b/specification/azsadmin/resource-manager/fabric/readme.md index 5d8cf9d15d0d..606cf1b9bb7b 100644 --- a/specification/azsadmin/resource-manager/fabric/readme.md +++ b/specification/azsadmin/resource-manager/fabric/readme.md @@ -116,6 +116,19 @@ input-file: - "Microsoft.Fabric.Admin/preview/2019-05-01/Volume.json" ``` +## Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: FabricLocation.json + where: $.definitions.FabricLocationModel.properties.externalDNSIPAddress01 + reason: externalDNSIPAddress01 is a customized name, no camel case restriction needed. + - suppress: DefinitionsPropertiesNamesCamelCase + from: FabricLocation.json + where: $.definitions.FabricLocationModel.properties.externalDNSIPAddress02 + reason: externalDNSIPAddress02 is a customized name, no camel case restriction needed. +``` + --- # Code Generation diff --git a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json index c44c6b48edb1..7a69e8aa17d7 100644 --- a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json +++ b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json @@ -666,7 +666,7 @@ }, "GalleryItemUriPayloadParameter": { "description": "The URI to the gallery item JSON file.", - "name": "galleryItemUri", + "name": "galleryItemUriPayload", "in": "body", "required": true, "schema": { diff --git a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/examples/GalleryItem/Create.json b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/examples/GalleryItem/Create.json index 42b01741e77d..aa3e2c71c21f 100644 --- a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/examples/GalleryItem/Create.json +++ b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/examples/GalleryItem/Create.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "0ff0bbbe-d68d-4314-8f68-80a808b5a6ec", "api-version": "2016-05-01", - "galleryItemUri": "https://github.com/Azure/AzureStack-Tools/raw/master/ComputeAdmin/microsoft.vmss.1.3.6.azpkg" + "galleryItemUriPayload": "https://github.com/Azure/AzureStack-Tools/raw/master/ComputeAdmin/microsoft.vmss.1.3.6.azpkg" }, "responses": { "200": { diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json deleted file mode 100644 index 550b4395dffc..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/acquisitions": { - "get": { - "x-ms-examples": { - "Returns a list of page BLOB acquisitions.": { - "$ref": "./examples/Acquisitions/List.json" - } - }, - "tags": [ - "Acquisitions" - ], - "operationId": "Acquisitions_List", - "description": "Returns a list of BLOB acquisitions.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/FilterParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of acquisitions has been returned.", - "schema": { - "$ref": "#/definitions/AcquisitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "AcquisitionStatus": { - "description": "The status of page BLOB acquisition.", - "type": "string", - "enum": [ - "InProgress", - "Success", - "Failed" - ], - "x-ms-enum": { - "name": "AcquisitionStatus", - "modelAsString": true - } - }, - "AcquisitionProperties": { - "description": "The Properties of page BLOB acquisition.", - "type": "object", - "properties": { - "filePath": { - "description": "The file path of the page BLOB file on storage cluster.", - "type": "string", - "readOnly": true - }, - "maximumblobsize": { - "description": "The maximum size of the page BLOB.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "status": { - "description": "The status of the page BLOB acquisition.", - "$ref": "#/definitions/AcquisitionStatus", - "readOnly": true - }, - "susbcriptionid": { - "description": "ID of the subscription associated with the page BLOB.", - "type": "string", - "readOnly": true - }, - "storageaccount": { - "description": "The storage account that holds the page BLOB.", - "type": "string", - "readOnly": true - }, - "container": { - "description": "The container associated with the page BLOB.", - "type": "string", - "readOnly": true - }, - "blob": { - "description": "The name of the page BLOB.", - "type": "string", - "readOnly": true - }, - "acquisitionid": { - "description": "The ID of page BLOB acquisition.", - "type": "string", - "readOnly": true - } - } - }, - "Acquisition": { - "description": "The acquisition of the page BLOB.", - "type": "object", - "properties": { - "properties": { - "description": "The properties of the page blob acquisition.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AcquisitionProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "AcquisitionList": { - "description": "The list of page BLOB acquisitions.", - "type": "array", - "items": { - "$ref": "#/definitions/Acquisition" - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json deleted file mode 100644 index 519ef48fa783..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json +++ /dev/null @@ -1,245 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the BLOB service.": { - "$ref": "./examples/BlobService/Get.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_Get", - "description": "Returns the BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The BLOB service has been returned.", - "schema": { - "$ref": "#/definitions/BlobService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns the list of metric definitions for BLOB service.": { - "$ref": "./examples/BlobService/ListMetricDefinitions.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_ListMetricDefinitions", - "description": "Returns the list of metric definitions for BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions for the BLOB service has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for BLOB service.": { - "$ref": "./examples/BlobService/ListMetrics.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_ListMetrics", - "description": "Returns a list of metrics for BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "BlobServiceWritableSettings": { - "description": "Settings of BLOB service.", - "type": "object", - "properties": { - "blobSvcContainerGcInterval": { - "description": "The interval, in seconds, of container garbage collection.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "blobSvcShallowGcInterval": { - "description": "The interval ,in seconds, of shallow garbage collection.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "blobSvcStreamMapMinContainerOccupancyPercent": { - "description": "The minimal container occupancy percent for stream mapping.", - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/WritableServiceSettings" - } - ] - }, - "BlobServiceSettings": { - "description": "Blob service settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BlobServiceWritableSettings" - } - ] - }, - "BlobServiceProperties": { - "description": "Blob service properties.", - "type": "object", - "properties": { - "settings": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BlobServiceSettings", - "description": "Blob service settings.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - }, - "BlobService": { - "description": "The BLOB service.", - "type": "object", - "properties": { - "properties": { - "description": "Blob service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/BlobServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json deleted file mode 100644 index 2e39b9862f23..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json +++ /dev/null @@ -1,449 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/operationresults/{operationId}": { - "post": { - "x-ms-examples": { - "Cancel a container migration job.": { - "$ref": "./examples/Containers/CancelMigration.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_CancelMigration", - "description": "Cancel a container migration job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Operation has been accepted and processed", - "schema": { - "$ref": "#/definitions/MigrationResult" - } - }, - "202": { - "description": "ACCEPTED - Operation has been accepted will be processed asynchronously", - "schema": { - "$ref": "#/definitions/MigrationResult" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "x-ms-examples": { - "Returns the status of a container migration job.": { - "$ref": "./examples/Containers/MigrationStatus.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_MigrationStatus", - "description": "Returns the status of a container migration job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Operation has been accepted and processed", - "schema": { - "$ref": "#/definitions/MigrationResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/containers": { - "get": { - "x-ms-examples": { - "Returns the list of containers which can be migrated in the specified share.": { - "$ref": "./examples/Containers/List.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_List", - "description": "Returns the list of containers which can be migrated in the specified share.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/MigrationIntentParameter" - }, - { - "$ref": "#/parameters/MaxCountParameter" - }, - { - "$ref": "#/parameters/StartIndexParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of containers has been returned.", - "schema": { - "$ref": "#/definitions/ContainerList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or share was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/destinationshares": { - "get": { - "x-ms-examples": { - "Returns a list of destination shares that the system considers as best candidates for migration.": { - "$ref": "./examples/Containers/ListDestinationShares.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_ListDestinationShares", - "description": "Returns a list of destination shares that the system considers as best candidates for migration.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of shares has been returned.", - "schema": { - "$ref": "shares.json#/definitions/ShareList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or share was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/migrate": { - "post": { - "x-ms-examples": { - "Starts a container migration job to migrate containers to the specified destination share.": { - "$ref": "./examples/Containers/Migrate.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_Migrate", - "description": "Starts a container migration job to migrate containers to the specified destination share.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/MigrationParameterParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Container has been migrated", - "schema": { - "$ref": "#/definitions/MigrationResult" - } - }, - "202": { - "description": "ACCEPTED -- Operation accepted and will be performed asynchronously", - "schema": { - "$ref": "#/definitions/MigrationResult" - } - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "Container": { - "description": "Container properties.", - "type": "object", - "properties": { - "sharename": { - "description": "The name of the share where the container locates.", - "type": "string", - "readOnly": true - }, - "accountname": { - "description": "The name of storage account where the container locates.", - "type": "string", - "readOnly": true - }, - "containername": { - "description": "Container name.", - "type": "string", - "readOnly": true - }, - "containerid": { - "description": "The container ID.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "accountid": { - "description": "The ID of the storage account.", - "type": "string", - "readOnly": true - }, - "usedBytesInPrimaryVolume": { - "description": "The used space, in bytes, of the container in the primary volume.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "containerState": { - "description": "The current state of the container.", - "type": "string", - "readOnly": true - } - } - }, - "ContainerList": { - "description": "List of containers.", - "type": "array", - "items": { - "$ref": "#/definitions/Container" - } - }, - "MigrationResult": { - "description": "The result of the container migration.", - "type": "object", - "properties": { - "jobId": { - "description": "The migration job ID.", - "type": "string", - "readOnly": true - }, - "sourceShareName": { - "description": "The name of the source storage share.", - "type": "string", - "readOnly": true - }, - "storageAccountName": { - "description": "The storage account name.", - "type": "string", - "readOnly": true - }, - "containerName": { - "description": "The name of the container to be migrated.", - "type": "string", - "readOnly": true - }, - "destinationShareName": { - "description": "The name of the destination storage share.", - "type": "string", - "readOnly": true - }, - "migrationStatus": { - "description": "The migration status.", - "$ref": "#/definitions/MigrationState", - "readOnly": true - }, - "subEntitiesCompleted": { - "description": "The number of entities which have been migrated.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "subEntitiesFailed": { - "description": "The number of entities which failed in migration.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "failureReason": { - "description": "The migration failure reason.", - "type": "string", - "readOnly": true - } - } - }, - "MigrationState": { - "type": "string", - "enum": [ - "Active", - "Paused", - "Deleted", - "Rollback", - "Complete", - "Canceled", - "Failed", - "All" - ], - "x-ms-enum": { - "name": "MigrationState", - "modelAsString": true - } - }, - "MigrationParameters": { - "description": "Parameters of container migration job.", - "type": "object", - "properties": { - "storageAccountName": { - "type": "string", - "description": "The name of the storage account where the container locates." - }, - "containerName": { - "type": "string", - "description": "The name of the container to be migrated." - }, - "destinationShareUncPath": { - "type": "string", - "description": "The UNC path of the destination share for migration." - } - }, - "required": [ - "storageAccountName", - "containerName", - "destinationShareUncPath" - ] - } - }, - "parameters": { - "MigrationIntentParameter": { - "description": "The container migration intent.", - "name": "Intent", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "MaxCountParameter": { - "description": "The maximum number of containers.", - "name": "MaxCount", - "in": "query", - "type": "integer", - "format": "int32", - "required": false, - "x-ms-parameter-location": "method" - }, - "StartIndexParameter": { - "description": "The starting index the resource provider uses.", - "name": "StartIndex", - "in": "query", - "type": "integer", - "format": "int32", - "required": false, - "x-ms-parameter-location": "method" - }, - "MigrationParameterParameter": { - "description": "The parameters of container migration job.", - "name": "migrationParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MigrationParameters" - }, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Acquisitions/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Acquisitions/List.json deleted file mode 100644 index 7c6d91a23a52..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Acquisitions/List.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": [] - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/Get.json deleted file mode 100644 index aff66c3516b5..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/Get.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/blobservices/default", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", - "type": "Microsoft.Storage.Admin/farms/blobservices", - "location": "local", - "properties": { - "settings": { - "frontEndHttpListenPort": 11000, - "frontEndHttpsListenPort": 11100, - "frontEndCallbackThreadsCount": 1600, - "frontEndCpuBasedKeepAliveThrottlingEnabled": true, - "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, - "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, - "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, - "frontEndMemoryThrottlingEnabled": true, - "frontEndMaxMillisecondsBetweenMemorySamples": 10000, - "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", - "frontEndMinThreadPoolThreads": 1850, - "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, - "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, - "frontEndUseSlaTimeInAvailability": true, - "blobSvcContainerGcInterval": 3600000, - "blobSvcShallowGcInterval": 3600000, - "blobSvcStreamMapMinContainerOccupancyPercent": 80 - }, - "version": "1.0" - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetricDefinitions.json deleted file mode 100644 index 9f0a7bc3caa6..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetricDefinitions.json +++ /dev/null @@ -1,348 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (BlobService)", - "value": "E2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (BlobService)", - "value": "ServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Availability (BlobService)", - "value": "Availability" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total successful requests (BlobService)", - "value": "SuccessfulRequests" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total requests (BlobService)", - "value": "TotalRequests" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Ingress (BlobService)", - "value": "Ingress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Egress (BlobService)", - "value": "Egress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (BlobFrontEnd)", - "value": "BlobFrontEndRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (BlobFrontEnd)", - "value": "BlobFrontEndE2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (BlobFrontEnd)", - "value": "BlobFrontEndServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Concurrent requests (BlobFrontEnd)", - "value": "BlobFrontEndConcurrentRequests" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "The count of pending requests in the request queue (BlobFrontEnd)", - "value": "BlobFrontEndRequestQueueLength" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage (BlobFrontEnd)", - "value": "BlobFrontEndProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (BlobServer)", - "value": "BlobServerRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (BlobServer)", - "value": "BlobServerServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetrics.json deleted file mode 100644 index 294e21053efb..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetrics.json +++ /dev/null @@ -1,386 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (BlobFrontEnd)", - "value": "BlobFrontEndRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "End-to-end latency (BlobFrontEnd)", - "value": "BlobFrontEndE2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (BlobFrontEnd)", - "value": "BlobFrontEndServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Concurrent requests (BlobFrontEnd)", - "value": "BlobFrontEndConcurrentRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "The count of pending requests in the request queue (BlobFrontEnd)", - "value": "BlobFrontEndRequestQueueLength" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage (BlobFrontEnd)", - "value": "BlobFrontEndProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (BlobServer)", - "value": "BlobServerRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (BlobServer)", - "value": "BlobServerServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 3.37839472205425, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 3.23720755548253, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 3.23283110690318, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 3.24997418164272, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 3.25500401782453, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 3.24891968824928, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 3.23743272199632, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "End-to-end latency (BlobService)", - "value": "E2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 3.00302941330881, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 2.88515644890154, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 2.8953629314371, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 2.90971362786012, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 2.9197896120973, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 2.90887585146789, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 2.89673016247954, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Server latency (BlobService)", - "value": "ServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 100.0, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Availability (BlobService)", - "value": "Availability" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 514291.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 553823.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 550283.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 590665.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 602316.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 592653.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 592690.0 - } - ], - "name": { - "localizedValue": "Total successful requests (BlobService)", - "value": "SuccessfulRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 525915.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 565447.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 561886.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 602269.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 613916.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 604253.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 604290.0 - } - ], - "name": { - "localizedValue": "Total requests (BlobService)", - "value": "TotalRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 1368310311.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 1404079959.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 1400057193.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 1445879884.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 1475166639.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 1463924092.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 1468371175.0 - } - ], - "name": { - "localizedValue": "Ingress (BlobService)", - "value": "Ingress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:02.3087124Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 1042768756.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 1140164863.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 902184482.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 1173363120.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 1184912696.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 1175637645.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 1175858765.0 - } - ], - "name": { - "localizedValue": "Egress (BlobService)", - "value": "Egress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/CancelMigration.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/CancelMigration.json deleted file mode 100644 index 17f7173515c8..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/CancelMigration.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "share": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "operationId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareName": "\\\\192.168.1.1\\DestinationShare", - "migrationStatus": "Canceled", - "subEntitiesCompleted": 165, - "subEntitiesFailed": 5, - "failureReason": "" - } - }, - "202": { - "body": { - "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareName": "\\\\192.168.1.1\\DestinationShare", - "migrationStatus": "Rollback", - "subEntitiesCompleted": 165, - "subEntitiesFailed": 5, - "failureReason": "" - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/List.json deleted file mode 100644 index 1cd17ea41735..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/List.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "Intent": "Migration", - "StartIndex": 0, - "MaxCount": 1000, - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthrestrequestprocessed", - "containerid": 22, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 2551603200, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthrestrequestaccept", - "containerid": 23, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 2282553344, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "frphealthaccount", - "containername": "azurestackhealthazssecurity", - "containerid": 6, - "accountid": "0a6b4f6b1de14cc08aa1fefadcc481eb", - "usedBytesInPrimaryVolume": 880074752, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthtsqueueresponse", - "containerid": 30, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 560037888, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthtsqueuerequest", - "containerid": 26, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 541351936, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "hrphealthaccount", - "containername": "azurestackhealthcentralmaeventtable", - "containerid": 37, - "accountid": "c2a6bdd19e404154afe27e2637e64ee1", - "usedBytesInPrimaryVolume": 456925184, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthblobsvcrpcverbose", - "containerid": 17, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 343273472, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "frphealthaccount", - "containername": "azurestackhealthsystemperfcounter60s", - "containerid": 7, - "accountid": "0a6b4f6b1de14cc08aa1fefadcc481eb", - "usedBytesInPrimaryVolume": 208580608, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthtstableresponse", - "containerid": 31, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 86974464, - "containerState": "Active" - }, - { - "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "accountname": "srphealthaccount", - "containername": "azurestackhealthtstablerequest", - "containerid": 28, - "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", - "usedBytesInPrimaryVolume": 85082112, - "containerState": "Active" - } - ] - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/ListDestinationShares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/ListDestinationShares.json deleted file mode 100644 index 3aad9bdbd061..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/ListDestinationShares.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": [] - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/Migrate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/Migrate.json deleted file mode 100644 index d342940f86e3..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/Migrate.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "api-version": "2015-12-01-preview", - "migrationParameters": { - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareUncPath": "\\\\192.168.1.1\\DestinationShare" - } - }, - "responses": { - "200": { - "body": { - "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareName": "\\\\192.168.1.1\\DestinationShare", - "migrationStatus": "Complete", - "subEntitiesCompleted": 165, - "subEntitiesFailed": 5, - "failureReason": "" - } - }, - "202": { - "body": { - "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareName": "\\\\192.168.1.1\\DestinationShare", - "migrationStatus": "Active", - "subEntitiesCompleted": 165, - "subEntitiesFailed": 5, - "failureReason": "" - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/MigrationStatus.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/MigrationStatus.json deleted file mode 100644 index d69c1287ff83..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/MigrationStatus.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "share": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "operationId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", - "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "storageAccountName": "StorageAccountName1", - "containerName": "ContainerName1", - "destinationShareName": "\\192.168.1.1", - "migrationStatus": "Active", - "subEntitiesCompleted": 165, - "subEntitiesFailed": 5, - "failureReason": "" - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Create.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Create.json deleted file mode 100644 index 841aa8f70f35..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Create.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview", - "farmObject": { - "properties": { - "settingAccessString": "local" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "type": "Microsoft.Storage.Admin/farms", - "location": "local", - "properties": { - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "version": "2015-12-01-preview", - "settingsStore": "AzS-ACS01.azurestack.local:19000", - "settings": { - "settingsPollingIntervalInSecond": 60, - "retentionPeriodForDeletedStorageAccountsInDays": 0, - "hostStyleHttpPort": 0, - "hostStyleHttpsPort": 0, - "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", - "dataCenterUriHostSuffixes": "local.azurestack.external", - "bandwidthThrottleIsEnabled": false, - "usageCollectionIntervalInSeconds": 10, - "feedbackRefreshIntervalInSeconds": 10, - "numberOfAccountsToSync": 20, - "defaultThrottleProbabilityDecayIntervalInSeconds": 240, - "gracePeriodForFullThrottlingInRefreshIntervals": 3, - "gracePeriodMaxThrottleProbability": 0.9, - "overallRequestThresholdInTps": 10000.0, - "defaultRequestThresholdInTps": 200.0, - "minimumRequestThresholdInTps": 1.0, - "toleranceFactorForTps": 2.0, - "overallIngressThresholdInGbps": 25.0, - "defaultIngressThresholdInGbps": 2.0, - "minimumIngressThresholdInGbps": 0.0008, - "toleranceFactorForIngress": 2.0, - "overallIntranetIngressThresholdInGbps": 25.0, - "defaultIntranetIngressThresholdInGbps": 2.0, - "minimumIntranetIngressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetIngress": 2.0, - "overallEgressThresholdInGbps": 30.0, - "defaultEgressThresholdInGbps": 3.0, - "minimumEgressThresholdInGbps": 0.0008, - "toleranceFactorForEgress": 2.0, - "overallIntranetEgressThresholdInGbps": 30.0, - "defaultIntranetEgressThresholdInGbps": 3.0, - "minimumIntranetEgressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetEgress": 2.0, - "overallTotalIngressThresholdInGbps": 50.0, - "defaultTotalIngressThresholdInGbps": 5.0, - "minimumTotalIngressThresholdInGbps": 0.0008, - "toleranceFactorForTotalIngress": 2.0, - "overallTotalEgressThresholdInGbps": 50.0, - "defaultTotalEgressThresholdInGbps": 5.0, - "minimumTotalEgressThresholdInGbps": 0.0008, - "toleranceFactorForTotalEgress": 2.0 - } - } - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Get.json deleted file mode 100644 index 6816ce27792f..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Get.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "type": "Microsoft.Storage.Admin/farms", - "location": "local", - "properties": { - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "version": "2015-12-01-preview", - "settingsStore": "AzS-ACS01.azurestack.local:19000", - "settings": { - "settingsPollingIntervalInSecond": 60, - "retentionPeriodForDeletedStorageAccountsInDays": 0, - "hostStyleHttpPort": 0, - "hostStyleHttpsPort": 0, - "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", - "dataCenterUriHostSuffixes": "local.azurestack.external", - "bandwidthThrottleIsEnabled": false, - "usageCollectionIntervalInSeconds": 10, - "feedbackRefreshIntervalInSeconds": 10, - "numberOfAccountsToSync": 20, - "defaultThrottleProbabilityDecayIntervalInSeconds": 240, - "gracePeriodForFullThrottlingInRefreshIntervals": 3, - "gracePeriodMaxThrottleProbability": 0.9, - "overallRequestThresholdInTps": 10000.0, - "defaultRequestThresholdInTps": 200.0, - "minimumRequestThresholdInTps": 1.0, - "toleranceFactorForTps": 2.0, - "overallIngressThresholdInGbps": 25.0, - "defaultIngressThresholdInGbps": 2.0, - "minimumIngressThresholdInGbps": 0.0008, - "toleranceFactorForIngress": 2.0, - "overallIntranetIngressThresholdInGbps": 25.0, - "defaultIntranetIngressThresholdInGbps": 2.0, - "minimumIntranetIngressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetIngress": 2.0, - "overallEgressThresholdInGbps": 30.0, - "defaultEgressThresholdInGbps": 3.0, - "minimumEgressThresholdInGbps": 0.0008, - "toleranceFactorForEgress": 2.0, - "overallIntranetEgressThresholdInGbps": 30.0, - "defaultIntranetEgressThresholdInGbps": 3.0, - "minimumIntranetEgressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetEgress": 2.0, - "overallTotalIngressThresholdInGbps": 50.0, - "defaultTotalIngressThresholdInGbps": 5.0, - "minimumTotalIngressThresholdInGbps": 0.0008, - "toleranceFactorForTotalIngress": 2.0, - "overallTotalEgressThresholdInGbps": 50.0, - "defaultTotalEgressThresholdInGbps": 5.0, - "minimumTotalEgressThresholdInGbps": 0.0008, - "toleranceFactorForTotalEgress": 2.0 - } - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/GetGarbageCollectionState.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/GetGarbageCollectionState.json deleted file mode 100644 index 21fb040c2211..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/GetGarbageCollectionState.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "operationId": "5ad334a7-4f51-141a-b52f-39a7df8d7033", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": "Failed?" - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/List.json deleted file mode 100644 index 4eb058df2035..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/List.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "type": "Microsoft.Storage.Admin/farms", - "location": "local", - "properties": { - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "version": "2015-12-01-preview", - "settingsStore": "AzS-ACS01.azurestack.local:19000", - "settings": { - "settingsPollingIntervalInSecond": 60, - "retentionPeriodForDeletedStorageAccountsInDays": 0, - "hostStyleHttpPort": 0, - "hostStyleHttpsPort": 0, - "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", - "dataCenterUriHostSuffixes": "local.azurestack.external", - "bandwidthThrottleIsEnabled": false, - "usageCollectionIntervalInSeconds": 10, - "feedbackRefreshIntervalInSeconds": 10, - "numberOfAccountsToSync": 20, - "defaultThrottleProbabilityDecayIntervalInSeconds": 240, - "gracePeriodForFullThrottlingInRefreshIntervals": 3, - "gracePeriodMaxThrottleProbability": 0.9, - "overallRequestThresholdInTps": 10000.0, - "defaultRequestThresholdInTps": 200.0, - "minimumRequestThresholdInTps": 1.0, - "toleranceFactorForTps": 2.0, - "overallIngressThresholdInGbps": 25.0, - "defaultIngressThresholdInGbps": 2.0, - "minimumIngressThresholdInGbps": 0.0008, - "toleranceFactorForIngress": 2.0, - "overallIntranetIngressThresholdInGbps": 25.0, - "defaultIntranetIngressThresholdInGbps": 2.0, - "minimumIntranetIngressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetIngress": 2.0, - "overallEgressThresholdInGbps": 30.0, - "defaultEgressThresholdInGbps": 3.0, - "minimumEgressThresholdInGbps": 0.0008, - "toleranceFactorForEgress": 2.0, - "overallIntranetEgressThresholdInGbps": 30.0, - "defaultIntranetEgressThresholdInGbps": 3.0, - "minimumIntranetEgressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetEgress": 2.0, - "overallTotalIngressThresholdInGbps": 50.0, - "defaultTotalIngressThresholdInGbps": 5.0, - "minimumTotalIngressThresholdInGbps": 0.0008, - "toleranceFactorForTotalIngress": 2.0, - "overallTotalEgressThresholdInGbps": 50.0, - "defaultTotalEgressThresholdInGbps": 5.0, - "minimumTotalEgressThresholdInGbps": 0.0008, - "toleranceFactorForTotalEgress": 2.0 - } - } - } - ] - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetricDefinitions.json deleted file mode 100644 index b6074badfafd..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetricDefinitions.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage", - "value": "ProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Available memory", - "value": "AvailableMemory" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total Capacity", - "value": "TotalCapacity" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Used Capacity", - "value": "UsedCapacity" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Free Space", - "value": "FreeSpace" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Used Capacity Percentage", - "value": "UsedCapacityPercentage " - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Free Space Percentage", - "value": "FreeSpacePercentage " - }, - "primaryAggregationType": "Average", - "unit": "Count" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetrics.json deleted file mode 100644 index 0196e9d4b8ae..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetrics.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage", - "value": "ProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Available memory", - "value": "AvailableMemory" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 2728176648192.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Total Capacity", - "value": "TotalCapacity" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 389873692672.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 379637998762.66669, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 369550244352.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 359099803818.66669, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 348343386965.33331, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 338910678186.66669, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 330334962346.66669, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Used Capacity", - "value": "UsedCapacity" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 2338302955520.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 2348538649429.3335, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 2358626403840.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 2369076844373.3335, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 2379833261226.6665, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 2389265970005.3335, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 2397841685845.3335, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Free Space", - "value": "FreeSpace" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 0.14290632277436091, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 0.139154478510128, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 0.13545686075603133, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 0.13162630215189586, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 0.12768358940253569, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 0.12422607546738861, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 0.12108268816302059, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Used Capacity Percentage", - "value": "UsedCapacityPercentage " - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:03.1837713Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 0.857093677225639, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 0.86084552148987215, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 0.86454313924396864, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 0.86837369784810392, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 0.87231641059746445, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 0.8757739245326116, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 0.87891731183697941, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Free Space Percentage", - "value": "FreeSpacePercentage " - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/StartGarbageCollection.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/StartGarbageCollection.json deleted file mode 100644 index b6d7923bdb15..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/StartGarbageCollection.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": {}, - "202": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Update.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Update.json deleted file mode 100644 index 7e548541c6f9..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Update.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview", - "farmObject": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "type": "Microsoft.Storage.Admin/farms", - "location": "local", - "properties": { - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "version": "2015-12-01-preview", - "settingsStore": "AzS-ACS01.azurestack.local:19000", - "settings": { - "settingsPollingIntervalInSecond": 60, - "retentionPeriodForDeletedStorageAccountsInDays": 0, - "hostStyleHttpPort": 0, - "hostStyleHttpsPort": 0, - "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", - "dataCenterUriHostSuffixes": "local.azurestack.external", - "bandwidthThrottleIsEnabled": false, - "usageCollectionIntervalInSeconds": 10, - "feedbackRefreshIntervalInSeconds": 10, - "numberOfAccountsToSync": 20, - "defaultThrottleProbabilityDecayIntervalInSeconds": 240, - "gracePeriodForFullThrottlingInRefreshIntervals": 3, - "gracePeriodMaxThrottleProbability": 0.9, - "overallRequestThresholdInTps": 10000.0, - "defaultRequestThresholdInTps": 200.0, - "minimumRequestThresholdInTps": 1.0, - "toleranceFactorForTps": 2.0, - "overallIngressThresholdInGbps": 25.0, - "defaultIngressThresholdInGbps": 2.0, - "minimumIngressThresholdInGbps": 0.0008, - "toleranceFactorForIngress": 2.0, - "overallIntranetIngressThresholdInGbps": 25.0, - "defaultIntranetIngressThresholdInGbps": 2.0, - "minimumIntranetIngressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetIngress": 2.0, - "overallEgressThresholdInGbps": 30.0, - "defaultEgressThresholdInGbps": 3.0, - "minimumEgressThresholdInGbps": 0.0008, - "toleranceFactorForEgress": 2.0, - "overallIntranetEgressThresholdInGbps": 30.0, - "defaultIntranetEgressThresholdInGbps": 3.0, - "minimumIntranetEgressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetEgress": 2.0, - "overallTotalIngressThresholdInGbps": 50.0, - "defaultTotalIngressThresholdInGbps": 5.0, - "minimumTotalIngressThresholdInGbps": 0.0008, - "toleranceFactorForTotalIngress": 2.0, - "overallTotalEgressThresholdInGbps": 50.0, - "defaultTotalEgressThresholdInGbps": 5.0, - "minimumTotalEgressThresholdInGbps": 0.0008, - "toleranceFactorForTotalEgress": 2.0 - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "type": "Microsoft.Storage.Admin/farms", - "location": "local", - "properties": { - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "version": "2015-12-01-preview", - "settingsStore": "AzS-ACS01.azurestack.local:19000", - "settings": { - "settingsPollingIntervalInSecond": 60, - "retentionPeriodForDeletedStorageAccountsInDays": 0, - "hostStyleHttpPort": 0, - "hostStyleHttpsPort": 0, - "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", - "dataCenterUriHostSuffixes": "local.azurestack.external", - "bandwidthThrottleIsEnabled": false, - "usageCollectionIntervalInSeconds": 10, - "feedbackRefreshIntervalInSeconds": 10, - "numberOfAccountsToSync": 20, - "defaultThrottleProbabilityDecayIntervalInSeconds": 240, - "gracePeriodForFullThrottlingInRefreshIntervals": 3, - "gracePeriodMaxThrottleProbability": 0.9, - "overallRequestThresholdInTps": 10000.0, - "defaultRequestThresholdInTps": 200.0, - "minimumRequestThresholdInTps": 1.0, - "toleranceFactorForTps": 2.0, - "overallIngressThresholdInGbps": 25.0, - "defaultIngressThresholdInGbps": 2.0, - "minimumIngressThresholdInGbps": 0.0008, - "toleranceFactorForIngress": 2.0, - "overallIntranetIngressThresholdInGbps": 25.0, - "defaultIntranetIngressThresholdInGbps": 2.0, - "minimumIntranetIngressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetIngress": 2.0, - "overallEgressThresholdInGbps": 30.0, - "defaultEgressThresholdInGbps": 3.0, - "minimumEgressThresholdInGbps": 0.0008, - "toleranceFactorForEgress": 2.0, - "overallIntranetEgressThresholdInGbps": 30.0, - "defaultIntranetEgressThresholdInGbps": 3.0, - "minimumIntranetEgressThresholdInGbps": 0.0008, - "toleranceFactorForIntranetEgress": 2.0, - "overallTotalIngressThresholdInGbps": 50.0, - "defaultTotalIngressThresholdInGbps": 5.0, - "minimumTotalIngressThresholdInGbps": 0.0008, - "toleranceFactorForTotalIngress": 2.0, - "overallTotalEgressThresholdInGbps": 50.0, - "defaultTotalEgressThresholdInGbps": 5.0, - "minimumTotalEgressThresholdInGbps": 0.0008, - "toleranceFactorForTotalEgress": 2.0 - } - } - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Operations/List.json deleted file mode 100644 index 66abbd5596b3..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Operations/List.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [] - } - } - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/Get.json deleted file mode 100644 index c2feb10ed55e..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/Get.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/queueservices/default", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", - "type": "Microsoft.Storage.Admin/farms/queueservices", - "location": "local", - "properties": { - "settings": { - "frontEndHttpListenPort": 11001, - "frontEndHttpsListenPort": 11101, - "frontEndCallbackThreadsCount": 1600, - "frontEndCpuBasedKeepAliveThrottlingEnabled": true, - "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, - "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, - "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, - "frontEndMemoryThrottlingEnabled": true, - "frontEndMaxMillisecondsBetweenMemorySamples": 10000, - "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", - "frontEndMinThreadPoolThreads": 1850, - "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, - "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, - "frontEndUseSlaTimeInAvailability": true - }, - "version": "1.0" - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetricDefinitions.json deleted file mode 100644 index 27b3fa0a8ad8..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetricDefinitions.json +++ /dev/null @@ -1,282 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (QueueService)", - "value": "E2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (QueueService)", - "value": "ServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Availability (QueueService)", - "value": "Availability" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total requests (QueueService)", - "value": "TotalRequests" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Ingress (QueueService)", - "value": "Ingress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Egress (QueueService)", - "value": "Egress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (QueueFrontEnd)", - "value": "QueueFrontEndRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (QueueFrontEnd)", - "value": "QueueFrontEndE2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (QueueFrontEnd)", - "value": "QueueFrontEndServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Concurrent requests (QueueFrontEnd)", - "value": "QueueFrontEndConcurrentRequests" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "The count of pending requests in the request queue (QueueFrontEnd)", - "value": "QueueFrontEndRequestQueueLength" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage (QueueFrontEnd)", - "value": "QueueFrontEndProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetrics.json deleted file mode 100644 index fc52b57ae9c6..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetrics.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (QueueFrontEnd)", - "value": "QueueFrontEndRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "End-to-end latency (QueueFrontEnd)", - "value": "QueueFrontEndE2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (QueueFrontEnd)", - "value": "QueueFrontEndServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Concurrent requests (QueueFrontEnd)", - "value": "QueueFrontEndConcurrentRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "The count of pending requests in the request queue (QueueFrontEnd)", - "value": "QueueFrontEndRequestQueueLength" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage (QueueFrontEnd)", - "value": "QueueFrontEndProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 1.88592776264484, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 1.85851217466339, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 1.87040051806059, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 1.90624102793048, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 1.93359342860519, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 1.91756062246845, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 1.90350660188966, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "End-to-end latency (QueueService)", - "value": "E2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 1.81003101711863, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 1.78567652998375, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 1.79746391271282, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 1.83270876455636, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 1.85885443391132, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 1.84392369316924, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 1.82936276116956, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Server latency (QueueService)", - "value": "ServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 100.0, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Availability (QueueService)", - "value": "Availability" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 709694.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 706686.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 706644.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 707869.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 711097.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 711197.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 713652.0 - } - ], - "name": { - "localizedValue": "Total requests (QueueService)", - "value": "TotalRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 330187754.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 328237824.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 328220543.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 328897291.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 330626016.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 330693320.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 332315876.0 - } - ], - "name": { - "localizedValue": "Ingress (QueueService)", - "value": "Ingress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:24.5345914Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 179169105.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 178217533.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 178211569.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 178640382.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 179836179.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 179870886.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 180647853.0 - } - ], - "name": { - "localizedValue": "Egress (QueueService)", - "value": "Egress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/CreateOrUpdate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/CreateOrUpdate.json deleted file mode 100644 index 28b75fe77346..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/CreateOrUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "location": "local", - "quotaName": "TestCreateQuota", - "api-version": "2015-12-01-preview", - "quotaObject": { - "properties": { - "numberOfStorageAccounts": 10000, - "capacityInGb": 1000 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", - "name": "local/TestCreateQuota", - "type": "Microsoft.Storage.Admin/locations/quotas", - "location": "local", - "properties": { - "numberOfStorageAccounts": 10000, - "capacityInGb": 1000 - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Delete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Delete.json deleted file mode 100644 index 63701114cbee..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "location": "local", - "quotaName": "TestCreateQuota", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": {}, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json deleted file mode 100644 index 6e845afce0db..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "location": "local", - "quotaName": "TestCreateQuota", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", - "name": "local/TestCreateQuota", - "type": "Microsoft.Storage.Admin/locations/quotas", - "location": "local", - "properties": { - "numberOfStorageAccounts": 20, - "capacityInGb": 2048 - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json deleted file mode 100644 index d88b9eb963c7..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "location": "local", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", - "name": "local/TestCreateQuota", - "type": "Microsoft.Storage.Admin/locations/quotas", - "location": "local", - "properties": { - "numberOfStorageAccounts": 20, - "capacityInGb": 2048 - } - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/Get.json deleted file mode 100644 index 21044b068cb5..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/Get.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/shares/||SU1FileServer.azurestack.local|SU1_ObjStore", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/||SU1FileServer.azurestack.local|SU1_ObjStore", - "type": "Microsoft.Storage.Admin/farms/shares", - "location": "local", - "properties": { - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "uncPath": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "totalCapacity": 2728176648192, - "usedCapacity": 400509059072, - "freeCapacity": 2327667589120, - "healthStatus": "Healthy" - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/List.json deleted file mode 100644 index e21e6a426129..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/List.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/shares/||SU1FileServer.azurestack.local|SU1_ObjStore", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/||SU1FileServer.azurestack.local|SU1_ObjStore", - "type": "Microsoft.Storage.Admin/farms/shares", - "location": "local", - "properties": { - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "uncPath": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", - "totalCapacity": 2728176648192, - "usedCapacity": 400509059072, - "freeCapacity": 2327667589120, - "healthStatus": "Healthy" - } - } - ] - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetricDefinitions.json deleted file mode 100644 index 8edc56a3e5bd..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetricDefinitions.json +++ /dev/null @@ -1,108 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total Capacity", - "value": "TotalCapacity" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Used Capacity", - "value": "UsedCapacity" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Free Space", - "value": "FreeSpace" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Used Capacity Percentage", - "value": "UsedCapacityPercentage " - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Free Space Percentage", - "value": "FreeSpacePercentage " - }, - "primaryAggregationType": "Average", - "unit": "Count" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetrics.json deleted file mode 100644 index 6a97f4850111..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetrics.json +++ /dev/null @@ -1,218 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endTime": "2018-01-30T19:31:25.5502828Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 2728176648192.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 2728176648192.0, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Total Capacity", - "value": "TotalCapacity" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:25.5502828Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 389873692672.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 379637998762.66669, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 369550244352.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 359099803818.66669, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 348343386965.33331, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 338910678186.66669, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 330334962346.66669, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Used Capacity", - "value": "UsedCapacity" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:25.5502828Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 2338302955520.0, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 2348538649429.3335, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 2358626403840.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 2369076844373.3335, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 2379833261226.6665, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 2389265970005.3335, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 2397841685845.3335, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Free Space", - "value": "FreeSpace" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:25.5502828Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 0.14290632277436091, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 0.139154478510128, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 0.13545686075603133, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 0.13162630215189586, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 0.12768358940253569, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 0.12422607546738861, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 0.12108268816302059, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Used Capacity Percentage", - "value": "UsedCapacityPercentage " - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:25.5502828Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 0.857093677225639, - "timeStamp": "2018-01-29T00:00:00Z" - }, - { - "average": 0.86084552148987215, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 0.86454313924396864, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 0.86837369784810392, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 0.87231641059746445, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 0.8757739245326116, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 0.87891731183697941, - "timeStamp": "2018-01-23T00:00:00Z" - } - ], - "name": { - "localizedValue": "Free Space Percentage", - "value": "FreeSpacePercentage " - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Get.json deleted file mode 100644 index 0cad5ac1196e..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Get.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "accountId": "f93c9df9e7af487fbda484a9201d9c18", - "api-version": "2015-12-01-preview", - "summary": "false" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/f93c9df9e7af487fbda484a9201d9c18", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "f93c9df9e7af487fbda484a9201d9c18", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://authprod.blob.local.azurestack.external/", - "queue": "https://authprod.queue.local.azurestack.external/", - "table": "https://authprod.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/authprod", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "authprod", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "f93c9df9e7af487fbda484a9201d9c18", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T01:56:30.983" - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/List.json deleted file mode 100644 index cf1c7933e60a..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/List.json +++ /dev/null @@ -1,242 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "api-version": "2015-12-01-preview", - "summary": "false" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0180624c67694706a4066782d83057a5", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "0180624c67694706a4066782d83057a5", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://adminkvlclproddata004.blob.local.azurestack.external/", - "queue": "https://adminkvlclproddata004.queue.local.azurestack.external/", - "table": "https://adminkvlclproddata004.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local.adminkeyvault/providers/Microsoft.Storage/storageaccounts/adminkvlclproddata004", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "adminkvlclproddata004", - "tenantResourceGroupName": "system.local.adminkeyvault", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "0180624c67694706a4066782d83057a5", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:27.41" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/04106a84393f4a12ab8efdbc0a69bb65", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "04106a84393f4a12ab8efdbc0a69bb65", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://adminkvlclproddata005.blob.local.azurestack.external/", - "queue": "https://adminkvlclproddata005.queue.local.azurestack.external/", - "table": "https://adminkvlclproddata005.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local.adminkeyvault/providers/Microsoft.Storage/storageaccounts/adminkvlclproddata005", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "adminkvlclproddata005", - "tenantResourceGroupName": "system.local.adminkeyvault", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "04106a84393f4a12ab8efdbc0a69bb65", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:27.847" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/06e296e00b284f5cb5708dfabd6ad74c", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "06e296e00b284f5cb5708dfabd6ad74c", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://wasphealthaccount.blob.local.azurestack.external/", - "queue": "https://wasphealthaccount.queue.local.azurestack.external/", - "table": "https://wasphealthaccount.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/wasphealthaccount", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "wasphealthaccount", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "06e296e00b284f5cb5708dfabd6ad74c", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:12.47" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0a6b4f6b1de14cc08aa1fefadcc481eb", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "0a6b4f6b1de14cc08aa1fefadcc481eb", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://frphealthaccount.blob.local.azurestack.external/", - "queue": "https://frphealthaccount.queue.local.azurestack.external/", - "table": "https://frphealthaccount.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/frphealthaccount", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "frphealthaccount", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "0a6b4f6b1de14cc08aa1fefadcc481eb", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:02.527" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0d724e3f75004e48948c1bfa0b4a964a", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "0d724e3f75004e48948c1bfa0b4a964a", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://systemgallery.blob.local.azurestack.external/", - "queue": "https://systemgallery.queue.local.azurestack.external/", - "table": "https://systemgallery.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/systemgallery", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "systemgallery", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "0d724e3f75004e48948c1bfa0b4a964a", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T01:56:29.467" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0dda0879146341178603ba151d7da010", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "0dda0879146341178603ba151d7da010", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://nrpeventsaccount.blob.local.azurestack.external/", - "queue": "https://nrpeventsaccount.queue.local.azurestack.external/", - "table": "https://nrpeventsaccount.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/nrpeventsaccount", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "nrpeventsaccount", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "0dda0879146341178603ba151d7da010", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:23.84" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/15612011f6094654abcb6031a4394ef5", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "15612011f6094654abcb6031a4394ef5", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://kvrphealthaccount.blob.local.azurestack.external/", - "queue": "https://kvrphealthaccount.queue.local.azurestack.external/", - "table": "https://kvrphealthaccount.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/kvrphealthaccount", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "kvrphealthaccount", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "15612011f6094654abcb6031a4394ef5", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:36.193" - } - }, - { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/17829fa81c154239ad8a6fae05f44793", - "type": "Microsoft.Storage.Admin/storageaccounts", - "name": "17829fa81c154239ad8a6fae05f44793", - "location": "local", - "properties": { - "provisioningState": "Succeeded", - "primaryEndpoints": { - "blob": "https://srpusageaccount.blob.local.azurestack.external/", - "queue": "https://srpusageaccount.queue.local.azurestack.external/", - "table": "https://srpusageaccount.table.local.azurestack.external/" - }, - "primaryLocation": "local", - "statusOfPrimary": "Available", - "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/srpusageaccount", - "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "tenantStorageAccountName": "srpusageaccount", - "tenantResourceGroupName": "system.local", - "currentOperation": "None", - "acquisitionOperationCount": 0, - "accountStatus": "Active", - "permissions": "Full", - "accountId": "17829fa81c154239ad8a6fae05f44793", - "wacInternalState": "Active", - "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:15.38" - } - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Synchronize.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Synchronize.json deleted file mode 100644 index d77de1a2e26f..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Synchronize.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "parameters": {}, - "responses": { - "200": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/SynchronizeAll.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/SynchronizeAll.json deleted file mode 100644 index d77de1a2e26f..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/SynchronizeAll.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "parameters": {}, - "responses": { - "200": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Undelete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Undelete.json deleted file mode 100644 index b8ac3474da2c..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Undelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "accountId": "f93c9df9e7af487fbda484a9201d9c18", - "api-version": "2015-12-01-preview", - "summary": "false" - }, - "responses": { - "200": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/Get.json deleted file mode 100644 index 779bc9f7fe55..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/Get.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/tableservices/default", - "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", - "type": "Microsoft.Storage.Admin/farms/tableservices", - "location": "local", - "properties": { - "settings": { - "frontEndHttpListenPort": 11002, - "frontEndHttpsListenPort": 11102, - "frontEndCallbackThreadsCount": 1600, - "frontEndCpuBasedKeepAliveThrottlingEnabled": true, - "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, - "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, - "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, - "frontEndMemoryThrottlingEnabled": true, - "frontEndMaxMillisecondsBetweenMemorySamples": 10000, - "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", - "frontEndMinThreadPoolThreads": 1850, - "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, - "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, - "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, - "frontEndUseSlaTimeInAvailability": true - }, - "version": "1.0" - } - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetricDefinitions.json deleted file mode 100644 index a9833dd670be..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetricDefinitions.json +++ /dev/null @@ -1,502 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (TableService)", - "value": "E2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (TableService)", - "value": "ServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Availability (TableService)", - "value": "Availability" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Total requests (TableService)", - "value": "TotalRequests" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Ingress (TableService)", - "value": "Ingress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P1D", - "timeGrain": "PT1M" - }, - { - "retention": "P10D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Egress (TableService)", - "value": "Egress" - }, - "primaryAggregationType": "Total", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (TableFrontEnd)", - "value": "TableFrontEndRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "End-to-end latency (TableFrontEnd)", - "value": "TableFrontEndE2ELatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (TableFrontEnd)", - "value": "TableFrontEndServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Concurrent requests (TableFrontEnd)", - "value": "TableFrontEndConcurrentRequests" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "The count of pending requests in the request queue (TableFrontEnd)", - "value": "TableFrontEndRequestQueueLength" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage (TableFrontEnd)", - "value": "TableFrontEndProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (TableMaster)", - "value": "TableMasterRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Successful requests per second (TableMaster)", - "value": "TableMasterSuccessfulRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Failed requests per second (TableMaster)", - "value": "TableMasterFailedRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (TableMaster)", - "value": "TableMasterServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage (TableMaster)", - "value": "TableMasterProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Requests per second (TableServer)", - "value": "TableServerRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Successful requests per second (TableServer)", - "value": "TableServerSuccessfulRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Failed requests per second (TableServer)", - "value": "TableServerFailedRequestsPerSecond" - }, - "primaryAggregationType": "Average", - "unit": "CountPerSecond" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Server latency (TableServer)", - "value": "TableServerServerLatency" - }, - "primaryAggregationType": "Average", - "unit": "Count" - }, - { - "metricAvailabilities": [ - { - "retention": "P10D", - "timeGrain": "PT1M" - }, - { - "retention": "P30D", - "timeGrain": "PT1H" - }, - { - "retention": "P60D", - "timeGrain": "P1D" - } - ], - "name": { - "localizedValue": "Processor time percentage (TableServer)", - "value": "TableServerProcessorTime" - }, - "primaryAggregationType": "Average", - "unit": "Count" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetrics.json deleted file mode 100644 index eef9e85e1666..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetrics.json +++ /dev/null @@ -1,434 +0,0 @@ -{ - "parameters": { - "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", - "resourceGroupName": "System.local", - "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", - "serviceType": "default", - "api-version": "2015-12-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (TableFrontEnd)", - "value": "TableFrontEndRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "End-to-end latency (TableFrontEnd)", - "value": "TableFrontEndE2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (TableFrontEnd)", - "value": "TableFrontEndServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Concurrent requests (TableFrontEnd)", - "value": "TableFrontEndConcurrentRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "The count of pending requests in the request queue (TableFrontEnd)", - "value": "TableFrontEndRequestQueueLength" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage (TableFrontEnd)", - "value": "TableFrontEndProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (TableMaster)", - "value": "TableMasterRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Successful requests per second (TableMaster)", - "value": "TableMasterSuccessfulRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Failed requests per second (TableMaster)", - "value": "TableMasterFailedRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (TableMaster)", - "value": "TableMasterServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage (TableMaster)", - "value": "TableMasterProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Requests per second (TableServer)", - "value": "TableServerRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Successful requests per second (TableServer)", - "value": "TableServerSuccessfulRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "CountPerSecond", - "metricValues": [], - "name": { - "localizedValue": "Failed requests per second (TableServer)", - "value": "TableServerFailedRequestsPerSecond" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Server latency (TableServer)", - "value": "TableServerServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [], - "name": { - "localizedValue": "Processor time percentage (TableServer)", - "value": "TableServerProcessorTime" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 7.29314082130133, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 7.29242044505202, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 7.45627809068669, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 7.30089294071398, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 7.72399956185191, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 7.60159978218237, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 7.47610318708534, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "End-to-end latency (TableService)", - "value": "E2ELatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 6.35217701106319, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 6.33429027113238, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 6.48739451176727, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 6.32658791815646, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 6.7042208266394, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 6.63925794831982, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 6.49650197949997, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Server latency (TableService)", - "value": "ServerLatency" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "average": 100.0, - "timeStamp": "2018-01-23T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-24T00:00:00Z" - }, - { - "average": 99.9981206752038, - "timeStamp": "2018-01-25T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-26T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-27T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-28T00:00:00Z" - }, - { - "average": 100.0, - "timeStamp": "2018-01-29T00:00:00Z" - } - ], - "name": { - "localizedValue": "Availability (TableService)", - "value": "Availability" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 269054.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 265771.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 266053.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 269687.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 276294.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 274176.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 279001.0 - } - ], - "name": { - "localizedValue": "Total requests (TableService)", - "value": "TotalRequests" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 511130540.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 503169523.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 507168827.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 568486028.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 700065592.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 690837578.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 695035903.0 - } - ], - "name": { - "localizedValue": "Ingress (TableService)", - "value": "Ingress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - }, - { - "endTime": "2018-01-30T19:31:22.8313413Z", - "metricUnit": "Count", - "metricValues": [ - { - "timeStamp": "2018-01-23T00:00:00Z", - "total": 6755876285.0 - }, - { - "timeStamp": "2018-01-24T00:00:00Z", - "total": 6754791566.0 - }, - { - "timeStamp": "2018-01-25T00:00:00Z", - "total": 6756295607.0 - }, - { - "timeStamp": "2018-01-26T00:00:00Z", - "total": 6762121121.0 - }, - { - "timeStamp": "2018-01-27T00:00:00Z", - "total": 6787273660.0 - }, - { - "timeStamp": "2018-01-28T00:00:00Z", - "total": 6749797687.0 - }, - { - "timeStamp": "2018-01-29T00:00:00Z", - "total": 6790505524.0 - } - ], - "name": { - "localizedValue": "Egress (TableService)", - "value": "Egress" - }, - "startTime": "2018-01-23T00:00:00Z", - "timeGrain": "P1D" - } - ] - } - }, - "404": {} - } -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json deleted file mode 100644 index 587563b84a40..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json +++ /dev/null @@ -1,656 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}": { - "put": { - "x-ms-examples": { - "Create a new storage farm.": { - "$ref": "./examples/Farms/Create.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Create a new storage farm.", - "operationId": "Farms_Create", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "description": "Parameters used to create a farm", - "name": "farmObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FarmCreationProperties" - } - } - ], - "responses": { - "200": { - "description": "OK -- The new storage farm has been created.", - "schema": { - "$ref": "#/definitions/Farm" - } - } - } - }, - "get": { - "x-ms-examples": { - "Returns the Storage properties and settings for a specified storage farm.": { - "$ref": "./examples/Farms/Get.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns the Storage properties and settings for a specified storage farm.", - "operationId": "Farms_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The farm has been returned.", - "schema": { - "$ref": "#/definitions/Farm" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - }, - "patch": { - "x-ms-examples": { - "Update an existing storage farm.": { - "$ref": "./examples/Farms/Update.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Update an existing storage farm.", - "operationId": "Farms_Update", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "description": "Farm to update.", - "name": "farmObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Farm" - } - } - ], - "responses": { - "200": { - "description": "OK -- The properties and settings of storage farm have been updated.", - "schema": { - "$ref": "#/definitions/Farm" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for a storage farm.": { - "$ref": "./examples/Farms/ListMetricDefinitions.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of metric definitions for a storage farm.", - "operationId": "Farms_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of storage farm metrics.": { - "$ref": "./examples/Farms/ListMetrics.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of storage farm metrics.", - "operationId": "Farms_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms": { - "get": { - "x-ms-examples": { - "Returns a list of all storage farms.": { - "$ref": "./examples/Farms/List.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of all storage farms.", - "operationId": "Farms_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage farms has been returned.", - "schema": { - "$ref": "#/definitions/FarmList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/ondemandgc": { - "post": { - "x-ms-examples": { - "Start garbage collection on deleted storage objects.": { - "$ref": "./examples/Farms/StartGarbageCollection.json" - } - }, - "tags": [ - "Farms" - ], - "operationId": "Farms_StartGarbageCollection", - "description": "Start garbage collection on deleted storage objects.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Garbage collection has completed." - }, - "202": { - "description": "ACCEPTED -- Garbage collection has started." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/operationresults/{operationId}": { - "get": { - "x-ms-examples": { - "Returns the state of the garbage collection job.": { - "$ref": "./examples/Farms/GetGarbageCollectionState.json" - } - }, - "tags": [ - "GC" - ], - "operationId": "Farms_GetGarbageCollectionState", - "description": "Returns the state of the garbage collection job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The state of garbage collection has been returned.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or garbage collection job can not be found." - } - } - } - } - }, - "definitions": { - "FarmList": { - "description": "Pageable list of storage farms.", - "type": "object", - "properties": { - "value": { - "description": "List of storage farms.", - "type": "array", - "items": { - "$ref": "#/definitions/Farm" - } - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "FarmCreationProperties": { - "description": "Storage farm properties.", - "type": "object", - "properties": { - "properties": { - "description": "Storage farm properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SettingAccessString" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "Farm": { - "description": "Storage farm.", - "type": "object", - "properties": { - "properties": { - "description": "Storage farm properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FarmProperties" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "FarmSettings": { - "description": "Storage farm settings.", - "type": "object", - "properties": { - "settingsPollingIntervalInSecond": { - "description": "The polling interval (in second).", - "type": "integer", - "format": "int32" - }, - "retentionPeriodForDeletedStorageAccountsInDays": { - "description": "The retention period (in days) for deleted storage account.", - "type": "integer", - "format": "int32" - }, - "hostStyleHttpPort": { - "description": "Host style HTTP port.", - "type": "integer", - "format": "int32" - }, - "hostStyleHttpsPort": { - "description": "Host style HTTPs port.", - "type": "integer", - "format": "int32" - }, - "corsAllowedOriginsList": { - "description": "The list of allowed origins.", - "type": "string" - }, - "dataCenterUriHostSuffixes": { - "description": "The suffixes of URI of hosts in data center.", - "type": "string" - }, - "bandwidthThrottleIsEnabled": { - "description": "Switch of bandwidth throttle enablement.", - "type": "boolean" - }, - "usageCollectionIntervalInSeconds": { - "description": "Interval (in seconds) of storage usage collection.", - "type": "integer", - "format": "int32" - }, - "feedbackRefreshIntervalInSeconds": { - "description": "Interval (in seconds) of feedback refresh.", - "type": "integer", - "format": "int32" - }, - "numberOfAccountsToSync": { - "description": "Number of accounts to sync.", - "type": "integer", - "format": "int32" - }, - "defaultThrottleProbabilityDecayIntervalInSeconds": { - "description": "Interval (in seconds) of default throttle probability decay.", - "type": "integer", - "format": "int32" - }, - "gracePeriodForFullThrottlingInRefreshIntervals": { - "description": "Grace period for full throttling in refresh intervals.", - "type": "integer", - "format": "int32" - }, - "gracePeriodMaxThrottleProbability": { - "description": "Maximum probability of throttle in grace period.", - "type": "number", - "format": "float" - }, - "overallRequestThresholdInTps": { - "description": "Overall request threshold (in TPS).", - "type": "number", - "format": "float" - }, - "defaultRequestThresholdInTps": { - "description": "Default request threshold (in TPS).", - "type": "number", - "format": "float" - }, - "minimumRequestThresholdInTps": { - "description": "Minimum request threshold (in TPS).", - "type": "number", - "format": "float" - }, - "toleranceFactorForTps": { - "description": "Tolerance factor for TPS.", - "type": "number", - "format": "float" - }, - "overallIngressThresholdInGbps": { - "description": "Overall ingress threshold (in Gbps)", - "type": "number", - "format": "float" - }, - "defaultIngressThresholdInGbps": { - "description": "Default ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumIngressThresholdInGbps": { - "description": "Minimum ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "toleranceFactorForIngress": { - "description": "Tolerance factor for ingress.", - "type": "number", - "format": "float" - }, - "overallIntranetIngressThresholdInGbps": { - "description": "Overall Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "defaultIntranetIngressThresholdInGbps": { - "description": "Default Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumIntranetIngressThresholdInGbps": { - "description": "Minimum Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "toleranceFactorForIntranetIngress": { - "description": "Tolerance factor for Intranet ingress.", - "type": "number", - "format": "float" - }, - "overallEgressThresholdInGbps": { - "description": "Overall egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "defaultEgressThresholdInGbps": { - "description": "Default egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumEgressThresholdInGbps": { - "description": "Minimum egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "toleranceFactorForEgress": { - "description": "Tolerance factor for egress.", - "type": "number", - "format": "float" - }, - "overallIntranetEgressThresholdInGbps": { - "description": "Overall Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "defaultIntranetEgressThresholdInGbps": { - "description": "Default Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumIntranetEgressThresholdInGbps": { - "description": "Minimum Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "toleranceFactorForIntranetEgress": { - "description": "Tolerance factor for Intranet egress.", - "type": "number", - "format": "float" - }, - "overallTotalIngressThresholdInGbps": { - "description": "Overall total ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "defaultTotalIngressThresholdInGbps": { - "description": "Default total ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumTotalIngressThresholdInGbps": { - "description": "Minimum total ingress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "toleranceFactorForTotalIngress": { - "description": "Tolerance factor for total ingress.", - "type": "number", - "format": "float" - }, - "overallTotalEgressThresholdInGbps": { - "description": "Overall total egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "defaultTotalEgressThresholdInGbps": { - "description": "Default total egress threshold (in Gbps).", - "type": "number", - "format": "float" - }, - "minimumTotalEgressThresholdInGbps": { - "description": "Minimum total egress threshold (in Gbp", - "type": "number", - "format": "float" - }, - "toleranceFactorForTotalEgress": { - "description": "Tolerance factor for total egress.", - "type": "number", - "format": "float" - } - } - }, - "FarmProperties": { - "description": "The properties of storage farm.", - "type": "object", - "properties": { - "farmId": { - "description": "Farm identifier.", - "type": "string" - }, - "version": { - "description": "Resource version.", - "type": "string" - }, - "settingsStore": { - "description": "The settings of storage farm.", - "type": "string" - }, - "settings": { - "description": "The properties of storage farm.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FarmSettings" - } - } - }, - "SettingAccessString": { - "description": "Setting access string.", - "type": "object", - "properties": { - "settingAccessString": { - "description": "Setting access string.", - "type": "string" - } - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json deleted file mode 100644 index a8c68ca4c60f..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the queue service.": { - "$ref": "./examples/QueueService/Get.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns the queue service.", - "operationId": "QueueServices_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Queue service has been returned.", - "schema": { - "$ref": "#/definitions/QueueService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for queue service.": { - "$ref": "./examples/QueueService/ListMetricDefinitions.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns a list of metric definitions for queue service.", - "operationId": "QueueServices_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for the queue service.": { - "$ref": "./examples/QueueService/ListMetrics.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns a list of metrics for the queue service.", - "operationId": "QueueServices_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "QueueServiceProperties": { - "description": "Queue service properties.", - "type": "object", - "properties": { - "settings": { - "description": "Queue service settings.", - "x-ms-client-flatten": true, - "$ref": "storage.json#/definitions/WritableServiceSettings", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - }, - "QueueService": { - "description": "Queue service.", - "type": "object", - "properties": { - "properties": { - "description": "Queue service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/QueueServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json deleted file mode 100644 index f047fdcf2d4d..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas/{quotaName}": { - "put": { - "x-ms-examples": { - "Create or update an existing storage quota.": { - "$ref": "./examples/Quotas/CreateOrUpdate.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Create or update an existing storage quota.", - "operationId": "StorageQuotas_CreateOrUpdate", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/QuotaNameParameter" - }, - { - "$ref": "#/parameters/StorgeQuotaParameters" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been created or updated.", - "schema": { - "$ref": "#/definitions/StorageQuota" - } - }, - "404": { - "description": "NOT FOUND -- The location or quota was not found." - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an existing storage quota.": { - "$ref": "./examples/Quotas/Delete.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Delete an existing quota", - "operationId": "StorageQuotas_Delete", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/QuotaNameParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been deleted." - }, - "404": { - "description": "NOT FOUND -- The location or storage quota cannot be found." - } - } - }, - "get": { - "x-ms-examples": { - "Returns the specified storage quota.": { - "$ref": "./examples/Quotas/Get.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Returns the specified storage quota.", - "operationId": "StorageQuotas_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/QuotaNameParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been returned.", - "schema": { - "$ref": "#/definitions/StorageQuota" - } - }, - "404": { - "description": "NOT FOUND -- The location or storage quota cannot be found." - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas": { - "get": { - "x-ms-examples": { - "Returns a list of storage quotas at the given location.": { - "$ref": "./examples/Quotas/List.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Returns a list of storage quotas at the given location.", - "operationId": "StorageQuotas_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage quotas has been returned.", - "schema": { - "$ref": "#/definitions/StorageQuotaList" - } - }, - "404": { - "description": "OK -- The location does not exist." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "StorageQuota": { - "description": "Storage quota.", - "type": "object", - "properties": { - "properties": { - "description": "Storage quota properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageQuotaProperties" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "StorageQuotaProperties": { - "description": "Storage quota properties.", - "type": "object", - "properties": { - "numberOfStorageAccounts": { - "description": "Total number of storage accounts.", - "type": "integer", - "format": "int32", - "default": 20 - }, - "capacityInGb": { - "description": "Maximum capacity (GB).", - "type": "integer", - "format": "int32", - "default": 500 - } - } - }, - "StorageQuotaList": { - "description": "Pageable list of storage quotas.", - "type": "object", - "properties": { - "value": { - "description": "List of storage quotas.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageQuota" - } - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string" - } - } - } - }, - "parameters": { - "QuotaNameParameter": { - "description": "The name of the storage quota.", - "name": "quotaName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "StorgeQuotaParameters": { - "description": "The properties of quota being created or updated.", - "name": "quotaObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageQuota" - }, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json deleted file mode 100644 index 4d978bc695cd..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json +++ /dev/null @@ -1,278 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares": { - "get": { - "x-ms-examples": { - "Returns a list of storage shares.": { - "$ref": "./examples/Shares/List.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of storage shares.", - "operationId": "Shares_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage shares has been returned.", - "schema": { - "$ref": "#/definitions/ShareList" - } - }, - "404": { - "description": "NOT FOUND -- The farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for a storage share.": { - "$ref": "./examples/Shares/ListMetrics.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of metrics for a storage share.", - "operationId": "Shares_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The farm or share cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for a storage share.": { - "$ref": "./examples/Shares/ListMetricDefinitions.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of metric definitions for a storage share.", - "operationId": "Shares_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}": { - "get": { - "x-ms-examples": { - "Returns a storage share.": { - "$ref": "./examples/Shares/Get.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a storage share.", - "operationId": "Shares_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage share has been returned.", - "schema": { - "$ref": "#/definitions/Share" - } - }, - "404": { - "description": "NOT FOUND -- The farm or storage share cannot be found." - } - } - } - } - }, - "definitions": { - "Share": { - "description": "Storage share.", - "type": "object", - "properties": { - "properties": { - "description": "Storage share properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ShareProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "ShareList": { - "description": "List of storage shares.", - "type": "array", - "items": { - "$ref": "#/definitions/Share" - } - }, - "ShareProperties": { - "description": "Storage share properties.", - "type": "object", - "properties": { - "shareName": { - "description": "The name of the storage share.", - "type": "string", - "readOnly": true - }, - "uncPath": { - "description": "The UNC path to the storage share.", - "type": "string", - "readOnly": true - }, - "totalCapacity": { - "description": "The total capacity of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "usedCapacity": { - "description": "The used capacity of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "freeCapacity": { - "description": "The free space of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "healthStatus": { - "description": "The health status of the storage share.", - "$ref": "storage.json#/definitions/HealthStatus", - "readOnly": true - } - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json deleted file mode 100644 index 087898639205..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json +++ /dev/null @@ -1,570 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Storage.Admin/operations": { - "get": { - "x-ms-examples": { - "Get the list of support rest operations.": { - "$ref": "./examples/Operations/List.json" - } - }, - "description": "Get the list of support rest operations.", - "tags": [ - "Commerce" - ], - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of operations has been returned.", - "schema": { - "$ref": "#/definitions/OperationList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "WritableSettings": { - "description": "Storage service settings.", - "type": "object", - "properties": { - "frontEndCallbackThreadsCount": { - "description": "Front end callback threads count.", - "type": "integer", - "format": "int32" - }, - "frontEndCpuBasedKeepAliveThrottlingEnabled": { - "description": "Switch of front end CPU based keep-alive throttling.", - "type": "boolean" - }, - "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": { - "description": "Threshold (% percentage) of front end CPU based keep-alive throttling.", - "type": "number", - "format": "float" - }, - "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": { - "description": "Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.", - "type": "number", - "format": "float" - }, - "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": { - "description": "Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.", - "type": "integer", - "format": "int32" - }, - "frontEndMemoryThrottlingEnabled": { - "description": "Switch of front end memory throttling.", - "type": "boolean" - }, - "frontEndMaxMillisecondsBetweenMemorySamples": { - "description": "Maximum interval (in millisecond) between memory samples of front end.", - "type": "integer", - "format": "int32" - }, - "frontEndMemoryThrottleThresholdSettings": { - "description": "Front end memory throttle threshold settings.", - "type": "string" - }, - "frontEndMinThreadPoolThreads": { - "description": "Front end minimum number of threads in thread pool.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": { - "description": "Threshold of front end thread pool based keep-alive IO completion.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": { - "description": "Threshold of front end thread pool based keep-alive worker thread.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": { - "description": "Monitor interval (in seconds) of front end thread pool based keep-alive monitor.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAlivePercentage": { - "description": "Percentage (%) of front end thread pool based keep-alive.", - "type": "number", - "format": "float" - }, - "frontEndUseSlaTimeInAvailability": { - "description": "Switch of whether front end uses SLA time in availability.", - "type": "boolean" - } - } - }, - "WritableServiceSettings": { - "description": "Settings of storage services.", - "type": "object", - "properties": { - "frontEndHttpsListenPort": { - "description": "The HTTPs port of the storage service front end.", - "type": "integer", - "format": "int32" - }, - "frontEndHttpListenPort": { - "description": "The HTTP port of the storage service front end.", - "type": "integer", - "format": "int32" - } - }, - "allOf": [ - { - "$ref": "#/definitions/WritableSettings" - } - ] - }, - "LocalizableString": { - "description": "Localizable string.", - "type": "object", - "properties": { - "value": { - "description": "Value of the string.", - "type": "string" - }, - "localizedValue": { - "description": "Localized value of the string.", - "type": "string" - } - } - }, - "MetricAvailability": { - "description": "Metric availability.", - "type": "object", - "properties": { - "timeGrain": { - "description": "Time grain.", - "type": "string" - }, - "retention": { - "description": "Retention of metric.", - "type": "string" - } - } - }, - "AggregateType": { - "description": "Aggregate type.", - "readOnly": true, - "type": "string", - "enum": [ - "None", - "Average", - "Total", - "Minimum", - "Maximum", - "Last" - ], - "x-ms-enum": { - "name": "AggregateType", - "modelAsString": true - } - }, - "MetricUnit": { - "description": "Metric unit.", - "type": "string", - "enum": [ - "Count", - "Bytes", - "Seconds", - "CountPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "MetricUnit", - "modelAsString": true - } - }, - "MetricDefinition": { - "description": "Metric definition.", - "type": "object", - "properties": { - "name": { - "description": "Metric name.", - "$ref": "#/definitions/LocalizableString", - "readOnly": true - }, - "unit": { - "description": "Metric unit.", - "$ref": "#/definitions/MetricUnit", - "readOnly": true - }, - "primaryAggregationType": { - "description": "Aggregation type of metric.", - "$ref": "#/definitions/AggregateType", - "readOnly": true - }, - "metricAvailabilities": { - "description": "Metric availabilities.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricAvailability" - }, - "readOnly": true - } - } - }, - "Metric": { - "description": "Metric information.", - "type": "object", - "properties": { - "name": { - "description": "Metric Name.", - "$ref": "#/definitions/LocalizableString", - "readOnly": true - }, - "metricUnit": { - "description": "Metric Unit.", - "$ref": "#/definitions/MetricUnit", - "readOnly": true - }, - "timeGrain": { - "description": "Metric time grain.", - "type": "string", - "readOnly": true - }, - "startTime": { - "description": "Metric start time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "endTime": { - "description": "Metric end time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "metricValues": { - "description": "List of metric values.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricValue" - }, - "readOnly": true - } - } - }, - "MetricDefinitionList": { - "description": "Pageable list of metric definitions.", - "type": "object", - "properties": { - "value": { - "description": "List of metric definitions.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricDefinition" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "MetricList": { - "description": "Pageable list of metrics.", - "type": "object", - "properties": { - "value": { - "description": "List of metrics.", - "type": "array", - "items": { - "$ref": "#/definitions/Metric" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "MetricValue": { - "description": "Metric value.", - "properties": { - "timeStamp": { - "description": "Timestamp of metric value.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "average": { - "description": "Average value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimum": { - "description": "Minimum value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "maximum": { - "description": "Maximum value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "total": { - "description": "Total value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "count": { - "description": "Count of metric values.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "properties": { - "description": "Metric value properties.", - "type": "string", - "readOnly": true - } - } - }, - "HealthStatus": { - "readOnly": true, - "description": "Current health status.", - "type": "string", - "enum": [ - "Unknown", - "Healthy", - "Warning", - "Critical" - ], - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": true - } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string" - }, - "name": { - "description": "Resource Name.", - "type": "string" - }, - "type": { - "description": "Resource type.", - "type": "string" - }, - "location": { - "description": "Resource location.", - "type": "string" - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "x-ms-azure-resource": true - }, - "Service": { - "description": "Storage service.", - "properties": { - "version": { - "description": "Storage service version.", - "type": "string" - }, - "healthStatus": { - "description": "Health status of storage service.", - "$ref": "#/definitions/HealthStatus" - } - } - }, - "Operation": { - "description": "Describes the supported REST operation.", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "Contains the localized display information for this particular operation / action.", - "$ref": "#/definitions/Display", - "readOnly": true - } - } - }, - "Display": { - "description": "Contains the localized display information for this particular operation / action.", - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The localized friendly name for the operation, as it should be shown to the user.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views.", - "type": "string", - "readOnly": true - } - } - }, - "OperationList": { - "description": "Pageable list of supported operations.", - "properties": { - "value": { - "description": "List of operations", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URI to the next page of operations.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "ServiceTypeParameter": { - "description": "The service type.", - "name": "serviceType", - "type": "string", - "in": "path", - "required": true, - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "ServiceType", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - }, - "ShareNameParameter": { - "description": "Share name.", - "name": "shareName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FilterParameter": { - "description": "Filter string", - "name": "$filter", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "LocationParameter": { - "description": "Resource location.", - "name": "location", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "SubscriptionIdParameter": { - "description": "Subscription Id.", - "name": "subscriptionId", - "type": "string", - "in": "path", - "required": true - }, - "FarmIdParameter": { - "description": "Farm Id.", - "type": "string", - "name": "farmId", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "description": "REST Api Version.", - "name": "api-version", - "type": "string", - "in": "query", - "required": true - }, - "ResourceGroupNameParameter": { - "description": "Resource group name.", - "name": "resourceGroupName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "OperationIdParameter": { - "description": "Operation Id.", - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json deleted file mode 100644 index 7563995ee609..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json +++ /dev/null @@ -1,441 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts": { - "get": { - "x-ms-examples": { - "Returns a list of storage accounts.": { - "$ref": "./examples/StorageAccounts/List.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Returns a list of storage accounts.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SummaryParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage accounts has been returned.", - "schema": { - "$ref": "#/definitions/StorageAccountList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts/{accountId}": { - "get": { - "x-ms-examples": { - "Returns the requested storage account.": { - "$ref": "./examples/StorageAccounts/Get.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Get", - "description": "Returns the requested storage account.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "#/parameters/AccountIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage account has been returned.", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - }, - "404": { - "description": "NOT FOUND -- The storage account or farm was not found." - } - } - }, - "post": { - "x-ms-examples": { - "Undelete a deleted storage account.": { - "$ref": "./examples/StorageAccounts/Undelete.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Undelete", - "description": "Undelete a deleted storage account.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "#/parameters/AccountIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Undelete either has been performed or account was not deleted." - } - } - } - } - }, - "definitions": { - "StorageAccountState": { - "readOnly": true, - "description": "Storage account state.", - "type": "string", - "enum": [ - "Creating", - "Succeeded", - "Suspended" - ], - "x-ms-enum": { - "name": "StorageAccountState", - "modelAsString": true - } - }, - "StorageAccountType": { - "description": "Storage account type.", - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_ZRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountType", - "modelAsString": true - } - }, - "LocationStatus": { - "readOnly": true, - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "LocationStatus", - "modelAsString": true - } - }, - "StorageAccountOperation": { - "readOnly": true, - "description": "The permissions of storage account in WAC.", - "type": "string", - "enum": [ - "None", - "Create", - "Update", - "Suspend", - "Delete", - "Undelete" - ], - "x-ms-enum": { - "name": "StorageAccountOperation", - "modelAsString": true - } - }, - "StorageAccountStatus": { - "description": "The state of storage account in WAC.", - "type": "string", - "enum": [ - "Active", - "Deleted", - "OutOfRetentionPeriod", - "Recycled" - ], - "x-ms-enum": { - "name": "StorageAccountStatus", - "modelAsString": true - } - }, - "WacAccountPermissions": { - "description": "Current operation being performed on Storage Account", - "type": "string", - "enum": [ - "Empty", - "None", - "Read", - "Delete", - "Write", - "Full" - ], - "x-ms-enum": { - "name": "WacAccountPermissions", - "modelAsString": true - } - }, - "WacAccountStates": { - "description": "Current operation being performed on Storage Account", - "type": "string", - "enum": [ - "None", - "Active", - "Deleted", - "AboveQuota", - "Suspended", - "All" - ], - "x-ms-enum": { - "name": "WacAccountStates", - "modelAsString": true - } - }, - "StorageAccountProperties": { - "description": "Properties of a storage account.", - "type": "object", - "properties": { - "tenantViewId": { - "description": "Resource URI of storage account from tenant view.", - "type": "string", - "readOnly": true - }, - "accountType": { - "description": "Storage account type.", - "$ref": "#/definitions/StorageAccountType", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state of storage account.", - "$ref": "#/definitions/StorageAccountState", - "readOnly": true - }, - "primaryEndpoints": { - "description": "The URLs that are used to perform a retrieval of a public BLOB, queue, or table object.", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - }, - "creationTime": { - "description": "The creation date and time of storage account in UTC.", - "type": "string", - "readOnly": true - }, - "alternateName": { - "description": "Alternative storage account name being used during undelete operation.", - "type": "string", - "readOnly": true - }, - "primaryLocation": { - "description": "The primary location for the storage account.", - "type": "string", - "readOnly": true - }, - "statusOfPrimary": { - "description": "The status of primary location of storage account.", - "$ref": "#/definitions/LocationStatus", - "readOnly": true - }, - "tenantSubscriptionId": { - "description": "Subscription ID of the subscription under which the storage account locates.", - "type": "string", - "readOnly": true - }, - "tenantStorageAccountName": { - "description": "Storage account name from tenant view.", - "type": "string", - "readOnly": true - }, - "tenantResourceGroupName": { - "description": "The name of resource group under which the storage account locates.", - "type": "string", - "readOnly": true - }, - "currentOperation": { - "description": "Current operation being performed on Storage Account", - "$ref": "#/definitions/StorageAccountOperation", - "readOnly": true - }, - "customDomain": { - "description": "The custom domain the user assigned to this storage account.", - "type": "string", - "readOnly": true - }, - "acquisitionOperationCount": { - "description": "The count of acquisitions in the storage account.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "deletedTime": { - "description": "The date-time when the storage account was deleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "accountStatus": { - "$ref": "#/definitions/StorageAccountStatus", - "description": "The status of storage account." - }, - "recoveredTime": { - "description": "The time when the storage account is undeleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "recycledTime": { - "description": "The time when the storage account is physically deleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "permissions": { - "description": "The permissions on the storage account.", - "$ref": "#/definitions/WacAccountPermissions", - "readOnly": true - }, - "accountId": { - "description": "Internal storage account ID, which is not visible to tenant.", - "type": "string", - "readOnly": true - }, - "wacInternalState": { - "description": "The internal state of storage account in WAC.", - "$ref": "#/definitions/WacAccountStates", - "readOnly": true - }, - "resourceAdminApiVersion": { - "description": "Storage admin REST API version.", - "type": "string", - "readOnly": true - } - } - }, - "StorageAccount": { - "description": "Properties of the storage account.", - "type": "object", - "properties": { - "properties": { - "description": "Properties of the storage account.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "StorageAccountList": { - "description": "Pageable list of storage accounts.", - "type": "object", - "properties": { - "value": { - "description": "List of storage accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "AccountIdParameter": { - "description": "Internal storage account ID, which is not visible to tenant.", - "name": "accountId", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SummaryParameter": { - "description": "Switch for whether summary or detailed information is returned.", - "name": "summary", - "in": "query", - "required": true, - "type": "boolean", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json deleted file mode 100644 index 044c0874eea1..000000000000 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the table service.": { - "$ref": "./examples/TableService/Get.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns the table service.", - "operationId": "TableServices_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Table service has been returned.", - "schema": { - "$ref": "#/definitions/TableService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for table service.": { - "$ref": "./examples/TableService/ListMetricDefinitions.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns a list of metric definitions for table service.", - "operationId": "TableServices_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for table service.": { - "$ref": "./examples/TableService/ListMetrics.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns a list of metrics for table service.", - "operationId": "TableServices_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "TableService": { - "description": "Table service.", - "type": "object", - "properties": { - "properties": { - "description": "Table service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/TableServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "TableServiceProperties": { - "description": "Table service properties.", - "type": "object", - "properties": { - "settings": { - "description": "Table service settings.", - "x-ms-client-flatten": true, - "$ref": "storage.json#/definitions/WritableServiceSettings", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/AsyncOperations/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/AsyncOperations/Get.json new file mode 100644 index 000000000000..5585f839670a --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/AsyncOperations/Get.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "asyncOperationId": "40cb64a9-e1b2-4915-b6af-30861fb3d01f", + "api-version": "2019-08-08-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Get.json index ddf05209bef8..92c56e8d0a3d 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Get.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/Get.json @@ -13,6 +13,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "f93c9df9e7af487fbda484a9201d9c18", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -27,11 +28,10 @@ "tenantStorageAccountName": "authprod", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "f93c9df9e7af487fbda484a9201d9c18", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T01:56:30.983" + "creationTime": "2018-01-17T01:56:30.983", + "healthState": "Healthy" } } } diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/List.json index ed522d0ea736..1989cf637dff 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/List.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageAccounts/List.json @@ -14,6 +14,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "0180624c67694706a4066782d83057a5", "location": "local", + "kind": "StorageV2", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -28,11 +29,11 @@ "tenantStorageAccountName": "adminkvlclproddata004", "tenantResourceGroupName": "system.local.adminkeyvault", "accountStatus": "Active", - "permissions": "Full", "accountId": "0180624c67694706a4066782d83057a5", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:27.41" + "creationTime": "2018-01-17T02:10:27.41", + "accessTier": "Cool", + "healthState": "Healthy" } }, { @@ -40,6 +41,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "04106a84393f4a12ab8efdbc0a69bb65", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -54,11 +56,10 @@ "tenantStorageAccountName": "adminkvlclproddata005", "tenantResourceGroupName": "system.local.adminkeyvault", "accountStatus": "Active", - "permissions": "Full", "accountId": "04106a84393f4a12ab8efdbc0a69bb65", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:27.847" + "creationTime": "2018-01-17T02:10:27.847", + "healthState": "Healthy" } }, { @@ -66,6 +67,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "06e296e00b284f5cb5708dfabd6ad74c", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -80,11 +82,10 @@ "tenantStorageAccountName": "wasphealthaccount", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "06e296e00b284f5cb5708dfabd6ad74c", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:12.47" + "creationTime": "2018-01-17T02:10:12.47", + "healthState": "Healthy" } }, { @@ -92,6 +93,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "0a6b4f6b1de14cc08aa1fefadcc481eb", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -106,11 +108,10 @@ "tenantStorageAccountName": "frphealthaccount", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "0a6b4f6b1de14cc08aa1fefadcc481eb", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:02.527" + "creationTime": "2018-01-17T02:10:02.527", + "healthState": "Healthy" } }, { @@ -118,6 +119,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "0d724e3f75004e48948c1bfa0b4a964a", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -132,11 +134,10 @@ "tenantStorageAccountName": "systemgallery", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "0d724e3f75004e48948c1bfa0b4a964a", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T01:56:29.467" + "creationTime": "2018-01-17T01:56:29.467", + "healthState": "Healthy" } }, { @@ -144,6 +145,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "0dda0879146341178603ba151d7da010", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -158,11 +160,10 @@ "tenantStorageAccountName": "nrpeventsaccount", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "0dda0879146341178603ba151d7da010", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:23.84" + "creationTime": "2018-01-17T02:10:23.84", + "healthState": "Healthy" } }, { @@ -170,6 +171,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "15612011f6094654abcb6031a4394ef5", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -184,11 +186,10 @@ "tenantStorageAccountName": "kvrphealthaccount", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "15612011f6094654abcb6031a4394ef5", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:36.193" + "creationTime": "2018-01-17T02:10:36.193", + "healthState": "Healthy" } }, { @@ -196,6 +197,7 @@ "type": "Microsoft.Storage.Admin/storageaccounts", "name": "17829fa81c154239ad8a6fae05f44793", "location": "local", + "kind": "Storage", "properties": { "provisioningState": "Succeeded", "primaryEndpoints": { @@ -210,11 +212,10 @@ "tenantStorageAccountName": "srpusageaccount", "tenantResourceGroupName": "system.local", "accountStatus": "Active", - "permissions": "Full", "accountId": "17829fa81c154239ad8a6fae05f44793", - "wacInternalState": "Active", "accountType": "Standard_LRS", - "creationTime": "2018-01-17T02:10:15.38" + "creationTime": "2018-01-17T02:10:15.38", + "healthState": "Healthy" } } ] diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Get.json new file mode 100644 index 000000000000..32602a1c222f --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroup": "system.local", + "serviceName": "PageBlob", + "api-version": "2019-08-08-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "PageBlob" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListResourceGroup.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListResourceGroup.json new file mode 100644 index 000000000000..7d0b86e2a57f --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListResourceGroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroup": "system.local", + "api-version": "2019-08-08-preview" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "serviceName": "PageBlob" + } + }, + { + "properties": { + "serviceName": "BlockBlob" + } + } + ] + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListSubscription.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListSubscription.json new file mode 100644 index 000000000000..c5d5346a3f7d --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/ListSubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "api-version": "2019-08-08-preview" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "serviceName": "PageBlob" + } + }, + { + "properties": { + "serviceName": "BlockBlob" + } + }, + { + "properties": { + "serviceName": "Table" + } + }, + { + "properties": { + "serviceName": "Queue" + } + } + ] + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Put.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Put.json new file mode 100644 index 000000000000..08379c802bae --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/examples/StorageServices/Put.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroup": "system.local", + "serviceName": "PageBlob", + "api-version": "2019-08-08-preview", + "storageServiceObject": { + "properties": { + "serviceName": "PageBlob" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "PageBlob" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json index 00f6b00027b6..a8039c32be30 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storage.json @@ -48,6 +48,205 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/asyncOperations/{asyncOperationId}": { + "get": { + "x-ms-examples": { + "Returns the async operation specified by asyncOperationId.": { + "$ref": "./examples/AsyncOperations/Get.json" + } + }, + "tags": [ + "AsyncOperations" + ], + "operationId": "AsyncOperations_Get", + "description": "Returns the async operation specified by asyncOperationId.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/AsyncOperationIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The async operation has been returned.", + "schema": { + "$ref": "#/definitions/AsyncOperationModel" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices": { + "get": { + "x-ms-examples": { + "Returns the storage services list under the specified resource group and subscription.": { + "$ref": "./examples/StorageServices/ListResourceGroup.json" + } + }, + "tags": [ + "StorageServices" + ], + "operationId": "StorageServices_ListRG", + "description": "Returns the storage services list under the specified resource group and subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage services has been returned.", + "schema": { + "$ref": "#/definitions/StorageServiceList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/storageServices": { + "get": { + "x-ms-examples": { + "Returns the storage services list under the specified subscription.": { + "$ref": "./examples/StorageServices/ListSubscription.json" + } + }, + "tags": [ + "StorageServices" + ], + "operationId": "StorageServices_ListSub", + "description": "Returns the storage services list under the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage services has been returned.", + "schema": { + "$ref": "#/definitions/StorageServiceList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.Storage.Admin/storageServices/{serviceName}": { + "get": { + "x-ms-examples": { + "Returns the specified storage service.": { + "$ref": "./examples/StorageServices/Get.json" + } + }, + "tags": [ + "StorageServices" + ], + "operationId": "StorageServices_Get", + "description": "Returns the specified storage service.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The specified storage service has been returned.", + "schema": { + "$ref": "#/definitions/StorageService" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create the specified storage resource.": { + "$ref": "./examples/StorageServices/Put.json" + } + }, + "tags": [ + "StorageServices" + ], + "operationId": "StorageServices_Create", + "description": "Create the specified storage resource.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The specified storage service has been created.", + "schema": { + "$ref": "#/definitions/StorageService" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -103,6 +302,141 @@ } } }, + "ServiceNameProperties": { + "description": "The properties for service name.", + "type": "object", + "properties": { + "serviceName": { + "description": "Service Name for Storage Service.", + "type": "string", + "readOnly": true + } + } + }, + "StorageService": { + "description": "MDM storage service resource.", + "type": "object", + "properties": { + "properties": { + "description": "Properties for service name.", + "$ref": "#/definitions/ServiceNameProperties", + "x-ms-client-flatten": true, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "StorageServiceList": { + "description": "List for storage services.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageService" + } + }, + "AsyncOperationModel": { + "description": "The async operation body for srp request.", + "type": "object", + "properties": { + "id": { + "description": "The operation id.", + "type": "string", + "readOnly": true + }, + "operationStartTime": { + "description": "Operation start time.", + "type": "string", + "readOnly": true + }, + "operationEndTime": { + "description": "Operation end time.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Subscription id for async operation.", + "type": "string", + "readOnly": true + }, + "locationHeader": { + "description": "Location header for async operation.", + "type": "string", + "readOnly": true + }, + "httpStatus": { + "description": "Http status for the async operation.", + "type": "string", + "readOnly": true + }, + "response": { + "description": "Response for the async operation.", + "type": "string", + "readOnly": true + }, + "context": { + "description": "Operation context.", + "$ref": "#/definitions/OperationRequestContext", + "x-ms-client-flatten": true, + "readOnly": true + }, + "operation": { + "description": "Async operation content.", + "$ref": "#/definitions/AsyncOperation", + "x-ms-client-flatten": true, + "readOnly": true + } + } + }, + "OperationRequestContext": { + "description": "Operation request context.", + "type": "object", + "properties": { + "apiVersion": { + "description": "Operation api version.", + "type": "string", + "readOnly": true + }, + "activityId": { + "description": "Activity id for the operation.", + "type": "string", + "readOnly": true + }, + "operationName": { + "description": "Async operation name.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Async operation error code if operation failed.", + "type": "string", + "readOnly": true + }, + "runtimeException": { + "description": "Runtime exception if operation failed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "AsyncOperation": { + "description": "Async operation content", + "type": "object", + "properties": { + "name": { + "description": "Async operation name", + "type": "string", + "readOnly": true + } + } + }, "ErrorResponse": { "description": "The error response for request which failed.", "type": "object", @@ -181,7 +515,32 @@ "name": "subscriptionId", "type": "string", "in": "path", - "required": true + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "description": "Async Operation Id.", + "name": "asyncOperationId", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "description": "Resource group name.", + "name": "resourceGroup", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "StorageServiceNameParameter": { + "description": "Storage service name.", + "name": "serviceName", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json index ddebe4a38cbd..58bf10a44dd3 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2019-08-08/storageaccounts.json @@ -16,7 +16,7 @@ "application/json" ], "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageaccounts": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageAccounts": { "get": { "x-ms-examples": { "Returns a list of storage accounts.": { @@ -64,7 +64,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageaccounts/{accountId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageAccounts/{accountId}": { "get": { "x-ms-examples": { "Returns the requested storage account.": { @@ -106,7 +106,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageaccounts/{accountId}/undelete": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/storageAccounts/{accountId}/undelete": { "post": { "x-ms-examples": { "Undelete a deleted storage account.": { @@ -206,8 +206,7 @@ "type": "string", "enum": [ "Creating", - "Succeeded", - "Suspended" + "Succeeded" ], "x-ms-enum": { "name": "StorageAccountState", @@ -254,36 +253,42 @@ "modelAsString": true } }, - "WacAccountPermissions": { - "description": "Current operation being performed on Storage Account", + "StorageAccountKind": { + "description": "The kind of storage account", "type": "string", "enum": [ - "Empty", - "None", - "Read", - "Delete", - "Write", - "Full" + "Storage", + "StorageV2", + "BlobStorage" ], "x-ms-enum": { - "name": "WacAccountPermissions", + "name": "StorageAccountKind", "modelAsString": true } }, - "WacAccountStates": { - "description": "Current operation being performed on Storage Account", + "StorageAccountAccessTier": { + "description": "Access tier for storage account", "type": "string", "enum": [ - "None", - "Active", - "Deleted", - "AboveQuota", + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "StorageAccountAccessTier", + "modelAsString": true + } + }, + "StorageAccountHealthState": { + "description": "Health state for storage account", + "type": "string", + "enum": [ + "Healthy", "Suspended", - "All", - "GcReadyState" + "OverQuota", + "SuspendedAndOverQuota" ], "x-ms-enum": { - "name": "WacAccountStates", + "name": "StorageAccountHealthState", "modelAsString": true } }, @@ -382,11 +387,6 @@ "type": "string", "readOnly": true }, - "alternateName": { - "description": "Alternative storage account name being used during undelete operation.", - "type": "string", - "readOnly": true - }, "primaryLocation": { "description": "The primary location for the storage account.", "type": "string", @@ -427,21 +427,11 @@ "$ref": "#/definitions/StorageAccountStatus", "description": "The status of storage account." }, - "permissions": { - "description": "The permissions on the storage account.", - "$ref": "#/definitions/WacAccountPermissions", - "readOnly": true - }, "accountId": { "description": "Internal storage account ID, which is not visible to tenant.", "type": "string", "readOnly": true }, - "wacInternalState": { - "description": "The internal state of storage account in WAC.", - "$ref": "#/definitions/WacAccountStates", - "readOnly": true - }, "encryption": { "description": "The storage encryption setting", "$ref": "#/definitions/StorageEncryption", @@ -451,6 +441,16 @@ "description": "Storage account supports https traffic only or not", "type": "boolean", "readOnly": true + }, + "accessTier": { + "description": "Required for storage accounts where kind = BlobStorage.", + "$ref": "#/definitions/StorageAccountAccessTier", + "readOnly": true + }, + "healthState": { + "description": "The internal health state for storage account.", + "$ref": "#/definitions/StorageAccountHealthState", + "readOnly": true } } }, @@ -464,6 +464,11 @@ "$ref": "#/definitions/StorageAccountProperties", "readOnly": true }, + "kind": { + "description": "Indicates the type of storage account", + "$ref": "#/definitions/StorageAccountKind", + "readOnly": true + }, "tags": { "description": "Resource tags.", "type": "object", diff --git a/specification/azsadmin/resource-manager/storage/readme.md b/specification/azsadmin/resource-manager/storage/readme.md index ea224b5519a0..fece5a0a5986 100644 --- a/specification/azsadmin/resource-manager/storage/readme.md +++ b/specification/azsadmin/resource-manager/storage/readme.md @@ -39,23 +39,6 @@ input-file: - "Microsoft.Storage.Admin/preview/2019-08-08/storage.json" - "Microsoft.Storage.Admin/preview/2019-08-08/acquisitions.json" ``` -### Tag: package-2015-12-01 - -These settings apply only when `--tag=package-2015-12-01` is specified on the command line. - -``` yaml $(tag) == 'package-2015-12-01' -input-file: - - "Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/quotas.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/storage.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/containers.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/farms.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/shares.json" - - "Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json" -``` --- # Code Generation @@ -92,16 +75,6 @@ input-file: - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/settings.json - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/storage.json - $(this-folder)/Microsoft.Storage.Admin/preview/2019-08-08/acquisitions.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/storage.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/containers.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/farms.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/shares.json - - $(this-folder)/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json ``` diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Manifest.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Manifest.json index ede98f5a13a7..aa38af5eefcb 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Manifest.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Manifest.json @@ -662,7 +662,7 @@ "Enabled" ], "x-ms-enum": { - "name": "ResourceDeletionPolicy", + "name": "LinkedAction", "modelAsString": true, "values": [ { @@ -875,7 +875,7 @@ "Succeeded" ], "x-ms-enum": { - "name": "MetricPrimaryAggregationType", + "name": "ManifestProvisioningState", "modelAsString": true, "values": [ { diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json index d2ed8205499f..9add0b5d584a 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json @@ -271,9 +271,6 @@ "$ref": "#/definitions/CheckNameAvailabilityResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, diff --git a/specification/azure-kusto/resource-manager/readme.cli.md b/specification/azure-kusto/resource-manager/readme.cli.md new file mode 100644 index 000000000000..6ecf12a9e8c1 --- /dev/null +++ b/specification/azure-kusto/resource-manager/readme.cli.md @@ -0,0 +1,44 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + namespace: azure.mgmt.kusto + flatten-all: true + test-scenario: + - name: KustoClustersCreateOrUpdate + - name: KustoDatabasesCreateOrUpdate + - name: KustoDataConnectionsCreateOrUpdate + - name: AttachedDatabaseConfigurationsCreateOrUpdate + - name: AttachedDatabaseConfigurationsGet + - name: KustoDataConnectionsGet + - name: KustoDatabasesListByCluster + - name: KustoAttachedDatabaseConfigurationsListByCluster + - name: KustoDatabasesGet + - name: KustoDatabasesListByCluster + - name: KustoClustersListResourceSkus + - name: KustoClustersGet + - name: KustoClustersListByResourceGroup + - name: KustoClustersList + - name: KustoClustersListSkus + - name: KustoOperationsList + - name: KustoDataConnectionsUpdate + - name: KustoDataConnectionValidation + - name: KustoDataConnectionsCheckNameAvailability + - name: KustoDatabaseRemovePrincipals + - name: KustoDatabaseListPrincipals + - name: KustoDatabaseAddPrincipals + - name: KustoDatabasesUpdate + - name: KustoClusterDetachFollowerDatabases + - name: KustoDatabaseCheckNameAvailability + - name: KustoClusterListFollowerDatabases + - name: KustoClustersStart + - name: KustoClustersStop + - name: KustoClustersUpdate + - name: KustoClustersCheckNameAvailability + - name: AttachedDatabaseConfigurationsDelete + - name: KustoDataConnectionsDelete + - name: KustoDatabasesDelete + - name: KustoClustersDelete +``` diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index 9f9a4e3bf0d0..ef739944f2eb 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -197,7 +197,7 @@ Please also specify `--azure-libraries-for-java=`. ```yaml $(tag) == 'package-2017-03-01-preview' && $(go) -namespace: Microsoft.AzureData -output-folder: $(go-sdks-folder)/services/preview/$(namespace)/mgmt/2017-03-01-preview/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-03-01-preview/$(namespace) ``` diff --git a/specification/azuredata/resource-manager/readme.typescript.md b/specification/azuredata/resource-manager/readme.typescript.md index c1e4a949375e..662b573cd1b5 100644 --- a/specification/azuredata/resource-manager/readme.typescript.md +++ b/specification/azuredata/resource-manager/readme.typescript.md @@ -8,6 +8,7 @@ typescript: azure-arm: true package-name: "azuredata" output-folder: "$(typescript-sdks-folder)/packages/azuredata" + clear-output-folder: true payload-flattening-threshold: 1 generate-metadata: true ``` diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json index 9b093117a3fd..3bb41c7bff94 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json @@ -143,6 +143,147 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/_all/GetProducts": { + "post": { + "x-ms-examples": { + "Returns a list of products.": { + "$ref": "examples/Product/ListPost.json" + } + }, + "tags": [ + "Product" + ], + "description": "Returns a list of products.", + "operationId": "Products_GetProducts", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "AzureStack.json#/parameters/RegistrationNameParameter" + }, + { + "$ref": "#/parameters/DeviceConfigurationParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "AzureStack.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/GetProduct": { + "post": { + "x-ms-examples": { + "Returns the specified product.": { + "$ref": "examples/Product/GetPost.json" + } + }, + "tags": [ + "Product" + ], + "description": "Returns the specified product.", + "operationId": "Products_GetProduct", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "AzureStack.json#/parameters/RegistrationNameParameter" + }, + { + "$ref": "#/parameters/ProductNameParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DeviceConfigurationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "AzureStack.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/uploadProductLog": { + "post": { + "x-ms-examples": { + "Returns the specified product.": { + "$ref": "examples/Product/UploadLog.json" + } + }, + "tags": [ + "Product" + ], + "description": "Returns the specified product.", + "operationId": "Products_UploadLog", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "AzureStack.json#/parameters/RegistrationNameParameter" + }, + { + "$ref": "#/parameters/ProductNameParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MarketplaceProductLogUpdateParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "AzureStack.json#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -408,9 +549,58 @@ "productProperties": { "description": "Additional properties for the product.", "$ref": "#/definitions/ProductProperties" + }, + "compatibility": { + "description": "Product compatibility with current device.", + "$ref": "#/definitions/Compatibility" + } + } + }, + "Compatibility": { + "description": "Product compatibility", + "type": "object", + "properties": { + "isCompatible": { + "description": "Tells if product is compatible with current device", + "type": "boolean" + }, + "message": { + "description": "Short error message if any compatibility issues are found", + "type": "string" + }, + "description": { + "description": "Full error message if any compatibility issues are found", + "type": "string" + }, + "issues": { + "description": "List of all issues found", + "type": "array", + "items": { + "$ref": "#/definitions/CompatibilityIssue" + } } } }, + "CompatibilityIssue": { + "description": "Compatibility issue", + "type": "string", + "enum": [ + "HigherDeviceVersionRequired", + "LowerDeviceVersionRequired", + "CapacityBillingModelRequired", + "PayAsYouGoBillingModelRequired", + "DevelopmentBillingModelRequired", + "AzureADIdentitySystemRequired", + "ADFSIdentitySystemRequired", + "ConnectionToInternetRequired", + "ConnectionToAzureRequired", + "DisconnectedEnvironmentRequired" + ], + "x-ms-enum": { + "name": "CompatibilityIssue", + "modelAsString": true + } + }, "IconUris": { "description": "Links to product icons.", "type": "object", @@ -477,6 +667,114 @@ } } } + }, + "DeviceConfiguration": { + "description": "Device Configuration.", + "properties": { + "deviceVersion": { + "description": "Version of the device.", + "type": "string", + "readOnly": true + }, + "identitySystem": { + "description": "Identity system of the device.", + "enum": [ + "AzureAD", + "ADFS" + ], + "type": "string", + "x-ms-enum": { + "name": "category", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "MarketplaceProductLogUpdate": { + "description": "Update details for product log.", + "properties": { + "operation": { + "description": "Operation to log.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Operation status to log.", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Error related to the operation.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Error details related to operation.", + "type": "string", + "readOnly": true + } + } + }, + "ProductLog": { + "description": "Product action log.", + "properties": { + "id": { + "description": "Log ID.", + "type": "string", + "readOnly": true + }, + "productId": { + "description": "Logged product ID.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Logged subscription ID.", + "type": "string", + "readOnly": true + }, + "registrationName": { + "description": "Logged registration name.", + "type": "string", + "readOnly": true + }, + "resourceGroupName": { + "description": "Logged resource group name.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Logged operation.", + "type": "string", + "readOnly": true + }, + "startDate": { + "description": "Operation start datetime.", + "type": "string", + "readOnly": true + }, + "endDate": { + "description": "Operation end datetime.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Operation status.", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Operation error data.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Operation error details.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { @@ -487,6 +785,26 @@ "in": "path", "required": true, "x-ms-parameter-location": "method" + }, + "DeviceConfigurationParameter": { + "description": "Device configuration.", + "name": "deviceConfiguration", + "in": "body", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeviceConfiguration" + } + }, + "MarketplaceProductLogUpdateParameter": { + "description": "Update details for product log.", + "name": "marketplaceProductLogUpdate", + "in": "body", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/MarketplaceProductLogUpdate" + } } }, "securityDefinitions": { diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/GetPost.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/GetPost.json new file mode 100644 index 000000000000..a26e3403bb63 --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/GetPost.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "resourceGroup": "azurestack", + "registrationName": "testregistration", + "productName": "Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "api-version": "2017-06-01", + "deviceConfiguration": { + "identitySystem": "AzureAD", + "deviceVersion": "1910.0.0.0" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "name": "testregistration/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "VM Access For Linux Extension", + "publisherDisplayName": "Microsoft Corp.", + "publisherIdentifier": "Microsoft.OSTCExtensions", + "offer": "", + "offerVersion": "", + "sku": "", + "vmExtensionType": "VMAccessForLinux", + "galleryItemIdentity": "Microsoft.VMAccessForLinux.1.4.7", + "iconUris": { + "large": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Large.png", + "wide": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Wide.png", + "medium": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Medium.png", + "small": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Small.png" + }, + "payloadLength": 46959, + "productKind": "virtualMachineExtension", + "productProperties": { + "version": "1.4.7" + }, + "compatibility": { + "isCompatible": true, + "message": "", + "description": "", + "issues": [] + } + } + } + } + } +} diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/ListPost.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/ListPost.json new file mode 100644 index 000000000000..8840a2d255e6 --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/ListPost.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "resourceGroup": "azurestack", + "registrationName": "testregistration", + "api-version": "2017-06-01", + "deviceConfiguration": { + "identitySystem": "AzureAD", + "deviceVersion": "1910.0.0.0" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "name": "testregistration/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "VM Access For Linux Extension", + "publisherDisplayName": "Microsoft Corp.", + "publisherIdentifier": "Microsoft.OSTCExtensions", + "offer": "", + "offerVersion": "", + "sku": "", + "vmExtensionType": "VMAccessForLinux", + "galleryItemIdentity": "Microsoft.VMAccessForLinux.1.4.7", + "iconUris": { + "large": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Large.png", + "wide": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Wide.png", + "medium": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Medium.png", + "small": "https://extensions.azureedge.net/Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1/icons/Small.png" + }, + "payloadLength": 46959, + "productKind": "virtualMachineExtension", + "productProperties": { + "version": "1.4.7" + }, + "compatibility": { + "isCompatible": true, + "message": "", + "description": "", + "issues": [] + } + } + }, + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/dummysharepoint", + "name": "testregistration/dummysharepoint", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "Display name for dummy SharePoint", + "publisherDisplayName": "Publisher display name for dummy SharePoint", + "publisherIdentifier": "Katal", + "offer": "Dummy offer", + "offerVersion": "FakeProduct: offer version", + "sku": "Dummy sku", + "galleryItemIdentity": "Microsoft.SharePointServer2013Trial-ARM.1.0.3", + "iconUris": { + "hero": "https://extensions.azureedge.net/dummysharepoint/icons/Hero.png", + "large": "https://extensions.azureedge.net/dummysharepoint/icons/Large.png", + "wide": "https://extensions.azureedge.net/dummysharepoint/icons/Wide.png", + "medium": "https://extensions.azureedge.net/dummysharepoint/icons/Medium.png", + "small": "https://extensions.azureedge.net/dummysharepoint/icons/Small.png" + }, + "payloadLength": 4682158, + "productKind": "virtualMachine", + "productProperties": { + "version": "1.0.1" + }, + "compatibility": { + "isCompatible": true, + "message": "", + "description": "", + "issues": [] + } + } + }, + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/dummysharepointTest526", + "name": "testregistration/dummysharepointTest526", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "Display name for dummy SharePoint", + "publisherDisplayName": "Publisher display name for dummy SharePoint", + "publisherIdentifier": "Katal", + "offer": "Dummy offer", + "offerVersion": "FakeProduct: offer version", + "sku": "Dummy sku", + "galleryItemIdentity": "Microsoft.SharePointServer2013Trial-ARM.1.0.3", + "iconUris": { + "hero": "https://extensions.azureedge.net/dummysharepointTest526/icons/Hero.png", + "large": "https://extensions.azureedge.net/dummysharepointTest526/icons/Large.png", + "wide": "https://extensions.azureedge.net/dummysharepointTest526/icons/Wide.png", + "medium": "https://extensions.azureedge.net/dummysharepointTest526/icons/Medium.png", + "small": "https://extensions.azureedge.net/dummysharepointTest526/icons/Small.png" + }, + "payloadLength": 4682158, + "productKind": "virtualMachine", + "productProperties": { + "version": "2.0.2" + }, + "compatibility": { + "isCompatible": true, + "message": "", + "description": "", + "issues": [] + } + } + }, + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d", + "name": "testregistration/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "Display name for dummy SharePoint", + "publisherDisplayName": "Publisher display name for dummy SharePoint", + "publisherIdentifier": "Katal", + "offer": "Dummy offer", + "offerVersion": "FakeProduct: offer version", + "sku": "Dummy sku", + "galleryItemIdentity": "Microsoft.SharePointServer2013Trial-ARM.1.0.3", + "iconUris": { + "hero": "https://extensions.azureedge.net/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d/icons/Hero.png", + "large": "https://extensions.azureedge.net/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d/icons/Large.png", + "wide": "https://extensions.azureedge.net/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d/icons/Wide.png", + "medium": "https://extensions.azureedge.net/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d/icons/Medium.png", + "small": "https://extensions.azureedge.net/test.product.976fe55e-6921-47bb-b8ba-718bba70c72d/icons/Small.png" + }, + "payloadLength": 4682158, + "productKind": "virtualMachine", + "productProperties": { + "version": "1.0.1" + }, + "compatibility": { + "isCompatible": true, + "message": "", + "description": "", + "issues": [] + } + } + }, + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration/products/wordpress4-4", + "name": "testregistration/wordpress4-4", + "type": "Microsoft.AzureStack/registrations/products", + "properties": { + "displayName": "WordPress", + "publisherDisplayName": "WordPress", + "publisherIdentifier": "bitnami", + "offer": "wordpress", + "offerVersion": "1.0.8", + "sku": "4-4", + "galleryItemIdentity": "bitnami.wordpress4-4.1.0.8", + "iconUris": { + "hero": "https://extensions.azureedge.net/wordpress4-4/icons/Hero.png", + "large": "https://extensions.azureedge.net/wordpress4-4/icons/Large.png", + "wide": "https://extensions.azureedge.net/wordpress4-4/icons/Wide.png", + "medium": "https://extensions.azureedge.net/wordpress4-4/icons/Medium.png", + "small": "https://extensions.azureedge.net/wordpress4-4/icons/Small.png" + }, + "payloadLength": 32212604365, + "productKind": "virtualMachine", + "productProperties": { + "version": "4.5.31" + }, + "compatibility": { + "isCompatible": false, + "message": "AzureStack version '1910.0.0.0' is too low. Versions lower than '1911.0.0.0' are not supported", + "description": "AzureStack version '1910.0.0.0' is too low. Versions lower than '1911.0.0.0' are not supported", + "issues": [ + "HigherDeviceVersionRequired" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/UploadLog.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/UploadLog.json new file mode 100644 index 000000000000..8d29e414c3fa --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Product/UploadLog.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "resourceGroup": "azurestack", + "registrationName": "testregistration", + "productName": "Microsoft.OSTCExtensions.VMAccessForLinux.1.4.7.1", + "api-version": "2017-06-01", + "marketplaceProductLogUpdate": { + "operation": "Download", + "status": "Failed", + "error": "ExampleError", + "details": "ExampleDetails" + } + }, + "responses": { + "200": { + "body": { + "details": "ExampleDetails", + "endDate": "01-02-2019 00:00:00", + "error": "ExampleError", + "operation": "Download", + "productId": "dummyProduct-1.1", + "registrationName": "TestCIRegistration007", + "resourceGroupName": "AzureStack007", + "startDate": "01-01-2019 00:00:00", + "status": "Failed", + "subscriptionId": "64D0A64B4F694EB4B0ED92BC34D98082" + } + } + } +} diff --git a/specification/azurestack/resource-manager/readme.md b/specification/azurestack/resource-manager/readme.md index 90e5770f6317..d31ec1ce03e3 100644 --- a/specification/azurestack/resource-manager/readme.md +++ b/specification/azurestack/resource-manager/readme.md @@ -126,11 +126,14 @@ Please also specify `--azure-libraries-for-java=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.azurestack + package-name: azure-mgmt-azurestack + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azurestack/azure-mgmt-azurestack/azure/mgmt/azurestack +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azurestack/azure-mgmt-azurestack +``` + \ No newline at end of file diff --git a/specification/azurestack/resource-manager/readme.typescript.md b/specification/azurestack/resource-manager/readme.typescript.md index 07a47ea5a2f3..7f520452f5d5 100644 --- a/specification/azurestack/resource-manager/readme.typescript.md +++ b/specification/azurestack/resource-manager/readme.typescript.md @@ -8,5 +8,6 @@ typescript: azure-arm: true package-name: "@azure/arm-azurestack" output-folder: "$(typescript-sdks-folder)/sdk/azurestack/arm-azurestack" + clear-output-folder: true generate-metadata: true ``` diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json index 18743ad61765..784ec593d4a5 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json @@ -2640,7 +2640,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "deploymentConfiguration": { "$ref": "#/definitions/DeploymentConfiguration", diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json index 8d707a32e74e..3037aa6c6d94 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json @@ -2778,7 +2778,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "deploymentConfiguration": { "$ref": "#/definitions/DeploymentConfiguration", diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2019-04-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2019-04-01/BatchManagement.json index 317c5da8b95f..56fac274fc9b 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2019-04-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2019-04-01/BatchManagement.json @@ -2814,7 +2814,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "deploymentConfiguration": { "$ref": "#/definitions/DeploymentConfiguration", diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json index a2fc026149b8..116ce7441348 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json @@ -2817,7 +2817,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "deploymentConfiguration": { "$ref": "#/definitions/DeploymentConfiguration", diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index a8d86ed9acdd..a2f1db7b2e8e 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -204,7 +204,7 @@ Please also specify `--azure-libraries-for-java=" + ] } ], "action": "Block" @@ -108,7 +125,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, @@ -154,6 +171,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -176,6 +194,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -188,6 +207,20 @@ "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -218,7 +251,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3" } diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPatchPolicy.json index cc8a4d747642..f2511b72fd82 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPatchPolicy.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPatchPolicy.json @@ -47,6 +47,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -69,6 +70,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -78,9 +80,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -111,7 +128,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, @@ -159,6 +176,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -181,6 +199,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -190,9 +209,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -223,7 +257,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyCreateOrUpdate.json index 76cce169ba38..3ce2f5a82cac 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyCreateOrUpdate.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyCreateOrUpdate.json @@ -29,6 +29,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -51,6 +52,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -60,9 +62,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -134,6 +151,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -156,6 +174,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -165,9 +184,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -198,7 +232,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, @@ -246,6 +280,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -268,6 +303,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -277,9 +313,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -310,7 +361,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, @@ -358,6 +409,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -380,6 +432,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -389,9 +442,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -422,7 +490,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyGet.json index dcce780502a9..3cfd8e73d78c 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyGet.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/examples/WafPolicyGet.json @@ -43,6 +43,7 @@ "selector": null, "operator": "IPMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "192.168.1.0/24", "10.0.0.0/24" @@ -65,6 +66,7 @@ "selector": null, "operator": "GeoMatch", "negateCondition": false, + "transforms": [], "matchValue": [ "CH" ] @@ -74,9 +76,24 @@ "selector": "UserAgent", "operator": "Contains", "negateCondition": false, + "transforms": [], "matchValue": [ "windows" ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] } ], "action": "Block" @@ -107,7 +124,7 @@ } ] }, - "cdnEndpointLinks": [ + "endpointLinks": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" }, diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json index ba7ec2ba875e..e3ccabfbb2ca 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json @@ -3399,15 +3399,15 @@ ] }, "sourcePattern": { - "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use \"/\" as the source pattern value. To match only the root directory and re-write this path, use the origin path field", "type": "string" }, "destination": { - "description": "Define the relative URL to which the above requests will be rewritten by.", + "description": "Define the destination path for be used in the rewrite. This will overwrite the source pattern ", "type": "string" }, "preserveUnmatchedPath": { - "description": "Whether to preserve unmatched path. Default value is true.", + "description": "If True, the remaining path after the source pattern will be appended to the new destination path. ", "type": "boolean" } } @@ -3917,6 +3917,10 @@ "modelAsString": true } }, + "customHttpsParameters": { + "description": "Certificate parameters for securing custom HTTPS", + "$ref": "#/definitions/CustomDomainHttpsParameters" + }, "validationData": { "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", "type": "string" @@ -3981,6 +3985,19 @@ "name": "ProtocolType", "modelAsString": true } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "minimumTlsVersion", + "modelAsString": false + } } } }, diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json new file mode 100644 index 000000000000..2d83acd4dca9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json @@ -0,0 +1,5359 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-12-31", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "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}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the CDN profiles within an Azure subscription.", + "operationId": "Profiles_List", + "x-ms-examples": { + "Profiles_List": { + "$ref": "./examples/Profiles_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the CDN profiles within a resource group.", + "operationId": "Profiles_ListByResourceGroup", + "x-ms-examples": { + "Profiles_ListByResourceGroup": { + "$ref": "./examples/Profiles_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Gets a CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Get", + "x-ms-examples": { + "Profiles_Get": { + "$ref": "./examples/Profiles_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "description": "Creates a new CDN profile with a profile name under the specified subscription and resource group.", + "operationId": "Profiles_Create", + "x-ms-examples": { + "Profiles_Create": { + "$ref": "./examples/Profiles_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "description": "Profile properties needed to create a new profile.", + "in": "body", + "name": "profile", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new profile has been created.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "description": "Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Update", + "x-ms-examples": { + "Profiles_Update": { + "$ref": "./examples/Profiles_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "profileUpdateParameters", + "in": "body", + "description": "Profile properties needed to update an existing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Profiles" + ], + "description": "Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", + "operationId": "Profiles_Delete", + "x-ms-examples": { + "Profiles_Delete": { + "$ref": "./examples/Profiles_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the profile was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "x-ms-examples": { + "Profiles_GenerateSsoUri": { + "$ref": "./examples/Profiles_GenerateSsoUri.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.", + "operationId": "Profiles_ListSupportedOptimizationTypes", + "x-ms-examples": { + "Profiles_ListSupportedOptimizationTypes": { + "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedOptimizationTypesListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given CDN profile.", + "operationId": "Profiles_ListResourceUsage", + "x-ms-examples": { + "Profiles_ListResourceUsage": { + "$ref": "./examples/Profiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Lists existing CDN endpoints.", + "operationId": "Endpoints_ListByProfile", + "x-ms-examples": { + "Endpoints_ListByProfile": { + "$ref": "./examples/Endpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Get", + "x-ms-examples": { + "Endpoints_Get": { + "$ref": "./examples/Endpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Create", + "x-ms-examples": { + "Endpoints_Create": { + "$ref": "./examples/Endpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "x-ms-examples": { + "Endpoints_Update": { + "$ref": "./examples/Endpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Delete", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the endpoint was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Starts an existing CDN endpoint that is on a stopped state.", + "operationId": "Endpoints_Start", + "x-ms-examples": { + "Endpoints_Start": { + "$ref": "./examples/Endpoints_Start.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Stops an existing running CDN endpoint.", + "operationId": "Endpoints_Stop", + "x-ms-examples": { + "Endpoints_Stop": { + "$ref": "./examples/Endpoints_Stop.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Removes a content from CDN.", + "operationId": "Endpoints_PurgeContent", + "x-ms-examples": { + "Endpoints_PurgeContent": { + "$ref": "./examples/Endpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Pre-loads a content to CDN. Available for Verizon Profiles.", + "operationId": "Endpoints_LoadContent", + "x-ms-examples": { + "Endpoints_LoadContent": { + "$ref": "./examples/Endpoints_LoadContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", + "operationId": "Endpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/Endpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.", + "operationId": "Endpoints_ListResourceUsage", + "x-ms-examples": { + "Endpoints_ListResourceUsage": { + "$ref": "./examples/Endpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "description": "Lists all of the existing origins within an endpoint.", + "operationId": "Origins_ListByEndpoint", + "x-ms-examples": { + "Origins_ListByEndpoint": { + "$ref": "./examples/Origins_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "description": "Gets an existing origin within an endpoint.", + "operationId": "Origins_Get", + "x-ms-examples": { + "Origins_Get": { + "$ref": "./examples/Origins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "description": "Creates a new origin within the specified endpoint.", + "operationId": "Origins_Create", + "x-ms-examples": { + "Origins_Create": { + "$ref": "./examples/Origins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "description": "Updates an existing origin within an endpoint.", + "operationId": "Origins_Update", + "x-ms-examples": { + "Origins_Update": { + "$ref": "./examples/Origins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Origins" + ], + "description": "Deletes an existing origin within an endpoint.", + "operationId": "Origins_Delete", + "x-ms-examples": { + "Origins_Delete": { + "$ref": "./examples/Origins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Lists all of the existing origin groups within an endpoint.", + "operationId": "OriginGroups_ListByEndpoint", + "x-ms-examples": { + "OriginsGroups_ListByEndpoint": { + "$ref": "./examples/OriginGroups_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Gets an existing origin group within an endpoint.", + "operationId": "OriginGroups_Get", + "x-ms-examples": { + "OriginGroups_Get": { + "$ref": "./examples/OriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OriginGroups" + ], + "description": "Creates a new origin group within the specified endpoint.", + "operationId": "OriginGroups_Create", + "x-ms-examples": { + "OriginGroups_Create": { + "$ref": "./examples/OriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "OriginGroups" + ], + "description": "Updates an existing origin group within an endpoint.", + "operationId": "OriginGroups_Update", + "x-ms-examples": { + "OriginGroups_Update": { + "$ref": "./examples/OriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "OriginGroups" + ], + "description": "Deletes an existing origin group within an endpoint.", + "operationId": "OriginGroups_Delete", + "x-ms-examples": { + "OriginGroups_Delete": { + "$ref": "./examples/OriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Lists all of the existing custom domains within an endpoint.", + "operationId": "CustomDomains_ListByEndpoint", + "x-ms-examples": { + "CustomDomains_ListByEndpoint": { + "$ref": "./examples/CustomDomains_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Gets an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Get", + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "description": "Creates a new custom domain within an endpoint.", + "operationId": "CustomDomains_Create", + "x-ms-examples": { + "CustomDomains_Create": { + "$ref": "./examples/CustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Properties required to create a new custom domain.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new custom domain has been created.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "description": "Deletes an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Delete", + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content. The request has been accepted but the custom domain was not found" + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Disable https delivery of the custom domain.", + "operationId": "CustomDomains_DisableCustomHttps", + "x-ms-examples": { + "CustomDomains_DisableCustomHttps": { + "$ref": "./examples/CustomDomains_DisableCustomHttps.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Enable https delivery of the custom domain.", + "operationId": "CustomDomains_EnableCustomHttps", + "x-ms-examples": { + "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json" + }, + "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainHttpsParameters", + "in": "body", + "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.", + "required": false, + "schema": { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": { + "post": { + "tags": [ + "ValidateProbe" + ], + "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.", + "operationId": "ValidateProbe", + "x-ms-examples": { + "ValidateProbe": { + "$ref": "./examples/ValidateProbe.json" + } + }, + "parameters": [ + { + "name": "validateProbeInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateProbeInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProbeOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": { + "post": { + "tags": [ + "CheckResourceUsage" + ], + "description": "Check the quota and actual usage of the CDN profiles under the given subscription.", + "operationId": "ResourceUsage_List", + "x-ms-examples": { + "ResourceUsage_List": { + "$ref": "./examples/ResourceUsage_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available CDN REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/edgenodes": { + "get": { + "tags": [ + "Edgenodes" + ], + "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.", + "operationId": "EdgeNodes_List", + "x-ms-examples": { + "EdgeNodes_List": { + "$ref": "./examples/EdgeNodes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EdgenodeResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Profile": { + "description": "CDN profile is a logical grouping of endpoints that share the same settings, such as CDN provider and pricing tier.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.", + "$ref": "#/definitions/Sku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties" + } + }, + "required": [ + "sku" + ] + }, + "ProfileProperties": { + "description": "The JSON object that contains the properties required to create a profile.", + "properties": { + "resourceState": { + "description": "Resource status of the profile.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the profile.", + "type": "string" + } + } + }, + "ProfileListResult": { + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN profiles within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of profile objects if there are any." + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Properties required to update a profile.", + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "SsoUri": { + "description": "The URI required to login to the supplemental portal from the Azure portal.", + "type": "object", + "properties": { + "ssoUriValue": { + "description": "The URI used to login to the supplemental portal.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportedOptimizationTypesListResult": { + "description": "The result of the GetSupportedOptimizationTypes API", + "type": "object", + "properties": { + "supportedOptimizationTypes": { + "description": "Supported optimization types for a profile.", + "readOnly": true, + "items": { + "$ref": "#/definitions/OptimizationType" + }, + "type": "array" + } + } + }, + "Endpoint": { + "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "origins": { + "description": "The source of the content being delivered via CDN.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + } + }, + "originGroups": { + "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOriginGroup" + } + }, + "resourceState": { + "description": "Resource status of the endpoint.", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the endpoint.", + "type": "string" + } + } + }, + "EndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "originPath": { + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean" + }, + "isHttpsAllowed": { + "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean" + }, + "queryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "$ref": "#/definitions/QueryStringCachingBehavior" + }, + "optimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.", + "$ref": "#/definitions/OptimizationType" + }, + "probePath": { + "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.", + "type": "string" + }, + "geoFilters": { + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", + "type": "array", + "items": { + "$ref": "#/definitions/GeoFilter" + } + }, + "defaultOriginGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "deliveryPolicy": { + "description": "A policy that specifies the delivery rules to be used for an endpoint.", + "type": "object", + "required": [ + "rules" + ], + "properties": { + "description": { + "description": "User-friendly description of the policy.", + "type": "string" + }, + "rules": { + "description": "A list of the delivery rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRule" + } + } + } + } + } + }, + "DeliveryRule": { + "description": "A rule that specifies a set of actions and conditions", + "type": "object", + "required": [ + "order", + "actions" + ], + "properties": { + "name": { + "description": "Name of the rule", + "type": "string" + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleCondition" + } + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleAction" + } + } + } + }, + "DeliveryRuleCondition": { + "description": "A condition for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the condition for the delivery rule.", + "type": "string", + "enum": [ + "RemoteAddress", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "RequestScheme", + "UrlPath", + "UrlFileExtension", + "UrlFileName", + "HttpVersion", + "Cookies", + "IsDevice" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + } + } + }, + "DeliveryRuleRemoteAddressCondition": { + "description": "Defines the RemoteAddress condition for the delivery rule.", + "x-ms-discriminator-value": "RemoteAddress", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RemoteAddressMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestMethodCondition": { + "description": "Defines the RequestMethod condition for the delivery rule.", + "x-ms-discriminator-value": "RequestMethod", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestMethodMatchConditionParameters" + } + } + }, + "DeliveryRuleQueryStringCondition": { + "description": "Defines the QueryString condition for the delivery rule.", + "x-ms-discriminator-value": "QueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/QueryStringMatchConditionParameters" + } + } + }, + "DeliveryRulePostArgsCondition": { + "description": "Defines the PostArgs condition for the delivery rule.", + "x-ms-discriminator-value": "PostArgs", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/PostArgsMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestUriCondition": { + "description": "Defines the RequestUri condition for the delivery rule.", + "x-ms-discriminator-value": "RequestUri", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestUriMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestHeaderCondition": { + "description": "Defines the RequestHeader condition for the delivery rule.", + "x-ms-discriminator-value": "RequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestHeaderMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestBodyCondition": { + "description": "Defines the RequestBody condition for the delivery rule.", + "x-ms-discriminator-value": "RequestBody", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestBodyMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestSchemeCondition": { + "description": "Defines the RequestScheme condition for the delivery rule.", + "x-ms-discriminator-value": "RequestScheme", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestSchemeMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlPathCondition": { + "description": "Defines the UrlPath condition for the delivery rule.", + "x-ms-discriminator-value": "UrlPath", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlPathMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileExtensionCondition": { + "description": "Defines the UrlFileExtension condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileExtension", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileNameCondition": { + "description": "Defines the UrlFileName condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileNameMatchConditionParameters" + } + } + }, + "DeliveryRuleHttpVersionCondition": { + "description": "Defines the HttpVersion condition for the delivery rule.", + "x-ms-discriminator-value": "HttpVersion", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HttpVersionMatchConditionParameters" + } + } + }, + "DeliveryRuleCookiesCondition": { + "description": "Defines the Cookies condition for the delivery rule.", + "x-ms-discriminator-value": "Cookies", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/CookiesMatchConditionParameters" + } + } + }, + "DeliveryRuleIsDeviceCondition": { + "description": "Defines the IsDevice condition for the delivery rule.", + "x-ms-discriminator-value": "IsDevice", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/IsDeviceMatchConditionParameters" + } + } + }, + "RemoteAddressMatchConditionParameters": { + "description": "Defines the parameters for RemoteAddress match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch" + ], + "x-ms-enum": { + "name": "RemoteAddressOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestMethodMatchConditionParameters": { + "description": "Defines the parameters for RequestMethod match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "RequestMethodOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "TRACE" + ] + } + } + } + }, + "QueryStringMatchConditionParameters": { + "description": "Defines the parameters for QueryString match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "QueryStringOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "PostArgsMatchConditionParameters": { + "description": "Defines the parameters for PostArgs match conditions", + "required": [ + "operator", + "matchValues", + "selector", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters" + ] + }, + "selector": { + "description": "Name of PostArg to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "PostArgsOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestUriMatchConditionParameters": { + "description": "Defines the parameters for RequestUri match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "RequestUriOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestHeaderMatchConditionParameters": { + "description": "Defines the parameters for RequestHeader match conditions", + "required": [ + "operator", + "matchValues", + "selector", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters" + ] + }, + "selector": { + "description": "Name of Header to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "RequestHeaderOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestBodyMatchConditionParameters": { + "description": "Defines the parameters for RequestBody match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "RequestBodyOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestSchemeMatchConditionParameters": { + "description": "Defines the parameters for RequestScheme match conditions ", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ] + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ] + } + } + } + }, + "UrlPathMatchConditionParameters": { + "description": "Defines the parameters for UrlPath match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "Wildcard" + ], + "x-ms-enum": { + "name": "UrlPathOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileExtensionMatchConditionParameters": { + "description": "Defines the parameters for UrlFileExtension match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "UrlFileExtensionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileNameMatchConditionParameters": { + "description": "Defines the parameters for UrlFilename match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "UrlFileNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HttpVersionMatchConditionParameters": { + "description": "Defines the parameters for HttpVersion match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "HttpVersionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CookiesMatchConditionParameters": { + "description": "Defines the parameters for Cookies match conditions", + "required": [ + "operator", + "matchValues", + "selector", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters" + ] + }, + "selector": { + "description": "Name of Cookies to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ], + "x-ms-enum": { + "name": "CookiesOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "IsDeviceMatchConditionParameters": { + "description": "Defines the parameters for IsDevice match conditions", + "required": [ + "operator", + "matchValues", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters" + ] + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "IsDeviceOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Mobile", + "Desktop" + ] + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "DeliveryRuleAction": { + "description": "An action for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the action for the delivery rule.", + "type": "string", + "enum": [ + "CacheExpiration", + "CacheKeyQueryString", + "ModifyRequestHeader", + "ModifyResponseHeader", + "UrlRedirect", + "UrlRewrite" + ], + "x-ms-enum": { + "name": "DeliveryRuleAction", + "modelAsString": true + } + } + } + }, + "UrlRedirectAction": { + "description": "Defines the url redirect action for the delivery rule.", + "x-ms-discriminator-value": "UrlRedirect", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRedirectActionParameters" + } + } + }, + "UrlRedirectActionParameters": { + "description": "Defines the parameters for the url redirect action.", + "required": [ + "redirectType", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters" + ] + }, + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "RedirectType", + "modelAsString": true + } + }, + "destinationProtocol": { + "description": "Protocol to use for the redirect. The default value is MatchRequest", + "type": "string", + "enum": [ + "MatchRequest", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "DestinationProtocol", + "modelAsString": true + } + }, + "customPath": { + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.", + "type": "string" + }, + "customHostname": { + "description": "Host to redirect. Leave empty to use the incoming host as the destination host.", + "type": "string" + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.", + "type": "string" + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + } + } + }, + "UrlRewriteAction": { + "description": "Defines the url rewrite action for the delivery rule.", + "x-ms-discriminator-value": "UrlRewrite", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRewriteActionParameters" + } + } + }, + "UrlRewriteActionParameters": { + "description": "Defines the parameters for the url rewrite action.", + "required": [ + "sourcePattern", + "destination", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters" + ] + }, + "sourcePattern": { + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "type": "string" + }, + "destination": { + "description": "Define the relative URL to which the above requests will be rewritten by.", + "type": "string" + }, + "preserveUnmatchedPath": { + "description": "Whether to preserve unmatched path. Default value is true.", + "type": "boolean" + } + } + }, + "DeliveryRuleRequestHeaderAction": { + "description": "Defines the request header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyRequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "DeliveryRuleResponseHeaderAction": { + "description": "Defines the response header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyResponseHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "HeaderActionParameters": { + "description": "Defines the parameters for the request header action.", + "required": [ + "headerAction", + "headerName", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters" + ] + }, + "headerAction": { + "description": "Action to perform", + "type": "string", + "enum": [ + "Append", + "Overwrite", + "Delete" + ], + "x-ms-enum": { + "name": "HeaderAction", + "modelAsString": true + } + }, + "headerName": { + "description": "Name of the header to modify", + "type": "string" + }, + "value": { + "description": "Value for the specified action", + "type": "string" + } + } + }, + "DeliveryRuleCacheExpirationAction": { + "description": "Defines the cache expiration action for the delivery rule.", + "x-ms-discriminator-value": "CacheExpiration", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheExpirationActionParameters" + } + } + }, + "CacheExpirationActionParameters": { + "description": "Defines the parameters for the cache expiration action.", + "required": [ + "cacheBehavior", + "cacheType", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters" + ] + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "BypassCache", + "Override", + "SetIfMissing" + ], + "x-ms-enum": { + "name": "cacheBehavior", + "modelAsString": true + } + }, + "cacheType": { + "description": "The level at which the content needs to be cached.", + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleCacheKeyQueryStringAction": { + "description": "Defines the cache-key query string action for the delivery rule.", + "x-ms-discriminator-value": "CacheKeyQueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheKeyQueryStringActionParameters" + } + } + }, + "CacheKeyQueryStringActionParameters": { + "description": "Defines the parameters for the cache-key query string action.", + "required": [ + "queryStringBehavior", + "@odata.type" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters" + ] + }, + "queryStringBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "Include", + "IncludeAll", + "Exclude", + "ExcludeAll" + ], + "x-ms-enum": { + "name": "queryStringBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string", + "x-nullable": true + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "DeepCreatedOrigin": { + "description": "The main origin of CDN content which is added when creating a CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name which must be unique within the endpoint. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginProperties": { + "description": "Properties of the origin created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.", + "type": "integer", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", + "type": "boolean" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroup": { + "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin group name which must be unique within the endpoint.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginGroupProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroupProperties": { + "description": "Properties of the origin group created on the CDN endpoint.", + "type": "object", + "required": [ + "origins" + ], + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + }, + "x-ms-azure-resource": true + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "GeoFilter": { + "description": "Rules defining user's geo access within a CDN endpoint.", + "type": "object", + "required": [ + "relativePath", + "action", + "countryCodes" + ], + "properties": { + "relativePath": { + "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)", + "type": "string" + }, + "action": { + "description": "Action of the geo filter, i.e. allow or block access.", + "enum": [ + "Block", + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoFilterActions", + "modelAsString": false + } + }, + "countryCodes": { + "description": "Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for content load.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin.", + "type": "string" + } + } + }, + "OriginUpdateParameters": { + "type": "object", + "description": "Origin properties needed for origin update.", + "properties": { + "tags": { + "description": "Origin tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not", + "type": "boolean" + } + } + }, + "OriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "OriginGroup": { + "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupProperties" + } + } + }, + "OriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin group.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginGroupResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin group.", + "type": "string" + } + } + }, + "OriginGroupUpdateParameters": { + "type": "object", + "description": "Origin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + } + }, + "HealthProbeParameters": { + "description": "The JSON object that contains the properties to send health probes to origin.", + "properties": { + "probePath": { + "description": "The path relative to the origin that is used to determine the health of the origin.", + "type": "string" + }, + "probeRequestType": { + "description": "The type of health probe request that is made.", + "enum": [ + "NotSet", + "GET", + "HEAD" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthProbeRequestType", + "modelAsString": false + } + }, + "probeProtocol": { + "description": "Protocol to use for health probe.", + "type": "string", + "enum": [ + "NotSet", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": false + } + }, + "probeIntervalInSeconds": { + "description": "The number of seconds between health probes.Default is 240sec.", + "type": "integer", + "maximum": 255, + "minimum": 1 + } + } + }, + "ResponseBasedOriginErrorDetectionParameters": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.", + "properties": { + "responseBasedDetectedErrorTypes": { + "description": "Type of response errors for real user requests for which origin will be deemed unhealthy", + "type": "string", + "enum": [ + "None", + "TcpErrorsOnly", + "TcpAndHttpErrors" + ], + "x-ms-enum": { + "name": "ResponseBasedDetectedErrorTypes", + "modelAsString": false + } + }, + "responseBasedFailoverThresholdPercentage": { + "description": "The percentage of failed requests in the sample where failover should trigger.", + "type": "integer", + "maximum": 100, + "minimum": 0 + }, + "httpErrorRanges": { + "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpErrorRangeParameters" + } + } + } + }, + "HttpErrorRangeParameters": { + "description": "The JSON object that represents the range for http status codes", + "properties": { + "begin": { + "description": "The inclusive start of the http status code range.", + "type": "integer", + "maximum": 999, + "minimum": 100 + }, + "end": { + "description": "The inclusive end of the http status code range.", + "type": "integer", + "maximum": 999, + "minimum": 100 + } + } + }, + "OriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "description": "List of CDN origin groups within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "CustomDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": true + } + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of Custom Https of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the custom domain.", + "type": "string" + } + } + }, + "CustomDomainParameters": { + "description": "The customDomain JSON object required for custom domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + } + }, + "CustomDomainPropertiesParameters": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "CustomDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a custom domain.", + "discriminator": "certificateSource", + "required": [ + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "AzureKeyVault", + "Cdn" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery.", + "enum": [ + "ServerNameIndication", + "IPBased" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": false + } + } + } + }, + "CdnManagedHttpsParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "x-ms-discriminator-value": "Cdn", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "$ref": "#/definitions/CdnCertificateSourceParameters" + } + } + }, + "CdnCertificateSourceParameters": { + "description": "Defines the parameters for using CDN managed certificate for securing custom domain.", + "required": [ + "@odata.type", + "certificateType" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters" + ] + }, + "certificateType": { + "description": "Type of certificate used", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + }, + "UserManagedHttpsParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "x-ms-discriminator-value": "AzureKeyVault", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.", + "required": [ + "@odata.type", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "secretVersion", + "updateRule", + "deleteRule" + ], + "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters" + ] + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "secretName": { + "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of Key Vault Secret in Key Vault.", + "type": "string" + }, + "updateRule": { + "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "UpdateRule", + "modelAsString": true + } + }, + "deleteRule": { + "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "DeleteRule", + "modelAsString": true + } + } + } + }, + "CustomDomainListResult": { + "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ValidateProbeInput": { + "description": "Input of the validate probe API.", + "properties": { + "probeURL": { + "description": "The probe URL to validate.", + "type": "string" + } + }, + "required": [ + "probeURL" + ], + "type": "object" + }, + "ValidateProbeOutput": { + "description": "Output of the validate probe API.", + "properties": { + "isValid": { + "description": "Indicates whether the probe URL is accepted or not.", + "readOnly": true, + "type": "boolean" + }, + "errorCode": { + "description": "Specifies the error code when the probe url is not accepted.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the probe URL is not accepted.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsageListResult": { + "description": "Output of check resource usage API.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "description": "List of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ResourceUsage": { + "description": "Output of check resource usage API.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type for which the usage is provided." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Unit of the usage. e.g. Count." + }, + "currentValue": { + "type": "integer", + "readOnly": true, + "description": "Actual value of usage on the specified resource type." + }, + "limit": { + "type": "integer", + "readOnly": true, + "description": "Quota of the specified resource type." + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "readOnly": true, + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "readOnly": true, + "type": "string" + } + } + } + } + }, + "OperationsListResult": { + "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of CDN operations supported by the CDN resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "EdgenodeResult": { + "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EdgeNode" + }, + "description": "Edge node of CDN service." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of edgenode list results if there are any." + } + } + }, + "EdgeNode": { + "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EdgeNodeProperties" + } + } + }, + "EdgeNodeProperties": { + "description": "The JSON object that contains the properties required to create an edgenode.", + "required": [ + "ipAddressGroups" + ], + "properties": { + "ipAddressGroups": { + "description": "List of ip address groups.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressGroup" + } + } + } + }, + "IpAddressGroup": { + "description": "CDN Ip address group", + "type": "object", + "properties": { + "deliveryRegion": { + "description": "The delivery region of the ip address group", + "type": "string" + }, + "ipv4Addresses": { + "description": "The list of ip v4 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + } + }, + "ipv6Addresses": { + "description": "The list of ip v6 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + } + } + } + }, + "cidrIpAddress": { + "description": "CIDR Ip address", + "type": "object", + "properties": { + "baseIpAddress": { + "description": "Ip address itself.", + "type": "string" + }, + "prefixLength": { + "description": "The length of the prefix of the ip address.", + "type": "integer" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "required": [ + "location" + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "QueryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "Sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.", + "properties": { + "name": { + "description": "Name of the pricing tier.", + "enum": [ + "Standard_Verizon", + "Premium_Verizon", + "Custom_Verizon", + "Standard_Akamai", + "Standard_ChinaCdn", + "Standard_Microsoft", + "Premium_ChinaCdn" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "OptimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.", + "enum": [ + "GeneralWebDelivery", + "GeneralMediaStreaming", + "VideoOnDemandMediaStreaming", + "LargeFileDownload", + "DynamicSiteAcceleration" + ], + "type": "string", + "x-ms-enum": { + "name": "OptimizationType", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2017-04-02." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..0ed21fe81461 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..407de083415c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CheckNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Create.json new file mode 100644 index 000000000000..3b1aecc6fe44 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Create.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customDomainProperties": { + "properties": { + "hostName": "www.someDomain.net" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..49c7fde06312 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_DisableCustomHttps.json new file mode 100644 index 000000000000..07e4ac17b862 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_DisableCustomHttps.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json new file mode 100644 index 000000000000..eb995fc91627 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "OData.type": "#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "vaultName": "kv", + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000", + "updateRule": "NoAction", + "deleteRule": "NoAction" + } + } + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json new file mode 100644 index 000000000000..22892a293d40 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "Cdn", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "OData.type": "#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters", + "certificateType": "Shared" + } + } + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..6a1f50675afa --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_ListByEndpoint.json new file mode 100644 index 000000000000..071dc287bd7b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/CustomDomains_ListByEndpoint.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/EdgeNodes_List.json new file mode 100644 index 000000000000..4273ff8d8efa --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/EdgeNodes_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2019-12-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "180.240.184.128", + "prefixLength": 25 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Premium_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Custom_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "2606:2800:420b::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Create.json new file mode 100644 index 000000000000..3cd43a0ae1e6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Create.json @@ -0,0 +1,543 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "originHostHeader": "www.bing.com", + "originPath": "/photos", + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters" + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*", + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip", + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters" + } + } + ] + } + ] + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "202": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "@odata.type": "#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..61f240eece45 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Get.json new file mode 100644 index 000000000000..d91fc54690d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Get.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListByProfile.json new file mode 100644 index 000000000000..62c8889c5a53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListByProfile.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListResourceUsage.json new file mode 100644 index 000000000000..94be14cf7278 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ListResourceUsage.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "customdomain", + "unit": "count", + "currentValue": 1, + "limit": 20 + }, + { + "resourceType": "geofilter", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_LoadContent.json new file mode 100644 index 000000000000..d8a3b7dc0ee4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_LoadContent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_PurgeContent.json new file mode 100644 index 000000000000..d8a3b7dc0ee4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_PurgeContent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Start.json new file mode 100644 index 000000000000..d5bda6e24110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Start.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Stop.json new file mode 100644 index 000000000000..fbe18fd3e8b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Stop.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Update.json new file mode 100644 index 000000000000..c185fdafe882 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_Update.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [] + } + } + }, + "202": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..88c6897f6e7d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Endpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Operations_List.json new file mode 100644 index 000000000000..37e682864297 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Operations_List.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2019-12-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cdn/register/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Microsoft.Cdn Resource Provider", + "operation": "Registers the Microsoft.Cdn Resource Provider" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/profiles/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/profiles/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "CheckResourceUsage" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "GenerateSsoUri" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Create.json new file mode 100644 index 000000000000..132310af4084 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Create.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "201": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "202": { + "body": { + "name": "originGroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Delete.json new file mode 100644 index 000000000000..a077a01ecb3c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Get.json new file mode 100644 index 000000000000..75572fe93958 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpAndHttpErrors", + "responseBasedFailoverThresholdPercentage": 10, + "httpErrorRanges": [ + { + "begin": 500, + "end": 505 + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_ListByEndpoint.json new file mode 100644 index 000000000000..e6fcbb1d488c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_ListByEndpoint.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Update.json new file mode 100644 index 000000000000..d1842b465ada --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/OriginGroups_Update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1", + "originGroupUpdateProperties": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Create.json new file mode 100644 index 000000000000..d3c150a3c64c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "origin": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + }, + "202": { + "body": { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Delete.json new file mode 100644 index 000000000000..6aa3a2d53dde --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "origin1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Get.json new file mode 100644 index 000000000000..be96f1425202 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_ListByEndpoint.json new file mode 100644 index 000000000000..4c2643e643a8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_ListByEndpoint.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Update.json new file mode 100644 index 000000000000..ba0d895812e3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Origins_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "originUpdateProperties": { + "tags": { + "key1": "value1" + }, + "properties": { + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + }, + "202": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Create.json new file mode 100644 index 000000000000..0be6ca9ceed5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Create.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profile": { + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + }, + "202": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Delete.json new file mode 100644 index 000000000000..9d4891b28a55 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_GenerateSsoUri.json new file mode 100644 index 000000000000..29a368137e06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_GenerateSsoUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "ssoUriValue": "https://someuri.com" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Get.json new file mode 100644 index 000000000000..514a0a46bbf1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Akamai" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_List.json new file mode 100644 index 000000000000..3c8685636552 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Akamai" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Akamai" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListByResourceGroup.json new file mode 100644 index 000000000000..dc4144a9ee91 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Akamai" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Akamai" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListResourceUsage.json new file mode 100644 index 000000000000..5e7061ca7644 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListResourceUsage.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "endpoint", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListSupportedOptimizationTypes.json new file mode 100644 index 000000000000..4940c90d7574 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_ListSupportedOptimizationTypes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "supportedOptimizationTypes": [ + "GeneralWebDelivery", + "DynamicSiteAcceleration" + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Update.json new file mode 100644 index 000000000000..9105c3e8c397 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/Profiles_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpdateParameters": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ResourceUsage_List.json new file mode 100644 index 000000000000..56dfe8243c9a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ResourceUsage_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "profile", + "unit": "count", + "currentValue": 31, + "limit": 200 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ValidateProbe.json new file mode 100644 index 000000000000..c26c47d0469d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/examples/ValidateProbe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2019-12-31", + "subscriptionId": "subid", + "validateProbeInput": { + "probeURL": "https://www.bing.com/image" + } + }, + "responses": { + "200": { + "body": { + "isValid": true, + "errorCode": "None", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index 52a58cae05d2..ac6e2f874a2f 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -31,6 +31,15 @@ openapi-type: arm tag: package-2019-04 ``` +### Tag: package-2019-12 + +These settings apply only when `--tag=package-2019-12` is specified on the command line. + +``` yaml $(tag) == 'package-2019-12' +input-file: +- Microsoft.Cdn/stable/2019-12-31/cdn.json +``` + ### Tag: package-2019-06 These settings apply only when `--tag=package-2019-06` is specified on the command line. @@ -158,6 +167,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Cdn/stable/2019-12-31/cdn.json - $(this-folder)/Microsoft.Cdn/preview/2019-06-15-preview/cdn.json - $(this-folder)/Microsoft.Cdn/preview/2019-06-15-preview/cdnwebapplicationfirewall.json - $(this-folder)/Microsoft.Cdn/stable/2019-04-15/cdn.json diff --git a/specification/cdn/resource-manager/readme.typescript.md b/specification/cdn/resource-manager/readme.typescript.md index bd2a17ef3bf2..148f723dbe4b 100644 --- a/specification/cdn/resource-manager/readme.typescript.md +++ b/specification/cdn/resource-manager/readme.typescript.md @@ -10,5 +10,6 @@ typescript: payload-flattening-threshold: 2 package-name: "@azure/arm-cdn" output-folder: "$(typescript-sdks-folder)/sdk/cdn/arm-cdn" + clear-output-folder: true generate-metadata: true ``` diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json index 3fd80c40c8bb..ce059f848f1b 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json @@ -3,7 +3,7 @@ "info": { "version": "1.0", "title": "Anomaly Detector Client", - "description": "The Anomaly Detector API detects anomalies automatically in time series data. It supports two functionalities, one is for detecting the whole series with model trained by the timeseries, another is detecting last point with model trained by points before. By using this service, business customers can discover incidents and establish a logic flow for root cause analysis." + "description": "The Anomaly Detector API detects anomalies automatically in time series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is for detecting trend changes in time series. In stateful mode, user can store time series, the stored time series will be used for detection anomalies. Under this mode, user can still use the above three functionalities by only giving a time range without preparing time series in client side. Besides the above three functionalities, stateful model also provide group based detection and labeling service. By leveraging labeling service user can provide labels for each detection result, these labels will be used for retuning or regenerating detection models. Inconsistency detection is a kind of group based detection, this detection will find inconsistency ones in a set of time series. By using anomaly detector service, business customers can discover incidents and establish a logic flow for root cause analysis." }, "securityDefinitions": { "apiKeyHeader": { @@ -43,12 +43,8 @@ } } ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "consumes": ["application/json"], + "produces": ["application/json"], "responses": { "200": { "description": "Successful operation.", @@ -86,12 +82,8 @@ } } ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "consumes": ["application/json"], + "produces": ["application/json"], "responses": { "200": { "description": "Successful operation.", @@ -112,6 +104,45 @@ } } } + }, + "/timeseries/changePoint/detect": { + "post": { + "summary": "Detect change point for the entire series", + "description": "Evaluate change point score of every series point", + "operationId": "ChangePointDetect", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.", + "required": true, + "schema": { + "$ref": "#/definitions/ChangePointDetectRequest" + } + } + ], + "consumes": ["application/json"], + "produces": ["application/json"], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/ChangePointDetectResponse" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Detect change point example": { + "$ref": "./examples/ChangePointDetect.json" + } + } + } } }, "definitions": { @@ -127,7 +158,10 @@ "InvalidGranularity", "InvalidPeriod", "InvalidModelArgument", - "InvalidSeries" + "InvalidSeries", + "InvalidJsonFormat", + "RequiredGranularity", + "RequiredSeries" ], "x-ms-enum": { "name": "AnomalyDetectorErrorCodes", @@ -140,12 +174,25 @@ } } }, + "Granularity": { + "type": "string", + "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.", + "x-nullable": false, + "x-ms-enum": { + "name": "Granularity", + "modelAsString": false + }, + "enum": ["yearly", "monthly", "weekly", "daily", "hourly", "minutely"] + }, + "CustomInterval": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}." + }, "Request": { "type": "object", - "required": [ - "granularity", - "series" - ], + "required": ["granularity", "series"], "properties": { "series": { "type": "array", @@ -155,25 +202,11 @@ } }, "granularity": { - "type": "string", - "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.", - "x-ms-enum": { - "name": "Granularity", - "modelAsString": false - }, - "enum": [ - "yearly", - "monthly", - "weekly", - "daily", - "hourly", - "minutely" - ] + "$ref": "#/definitions/Granularity" }, "customInterval": { - "type": "integer", - "format": "int32", - "description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}." + "description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}.", + "$ref": "#/definitions/CustomInterval" }, "period": { "type": "integer", @@ -194,10 +227,7 @@ }, "Point": { "type": "object", - "required": [ - "timestamp", - "value" - ], + "required": ["timestamp", "value"], "properties": { "timestamp": { "type": "string", @@ -332,6 +362,70 @@ "description": "Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one." } } + }, + "ChangePointDetectRequest": { + "type": "object", + "required": ["granularity", "series"], + "properties": { + "series": { + "type": "array", + "description": "Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.", + "items": { + "$ref": "#/definitions/Point" + } + }, + "granularity": { + "$ref": "#/definitions/Granularity", + "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid." + }, + "customInterval": { + "description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}.", + "$ref": "#/definitions/CustomInterval" + }, + "period": { + "type": "integer", + "format": "int32", + "description": "Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically." + }, + "stableTrendWindow": { + "type": "integer", + "format": "int32", + "description": "Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection." + }, + "threshold": { + "type": "number", + "format": "float", + "description": "Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted." + } + } + }, + "ChangePointDetectResponse": { + "type": "object", + "required": ["isChangePoint", "confidenceScores", "period"], + "properties": { + "period": { + "type": "integer", + "format": "int32", + "description": "Frequency extracted from the series, zero means no recurrent pattern has been found." + }, + "isChangePoint": { + "type": "array", + "description": "isChangePoint contains change point properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series.", + "items": { + "type": "boolean", + "x-nullable": false + } + }, + "confidenceScores": { + "type": "array", + "description": "the change point confidence of each point", + "items": { + "type": "number", + "format": "float", + "x-nullable": false + } + } + } } }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/examples/ChangePointDetect.json b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/examples/ChangePointDetect.json new file mode 100644 index 000000000000..e8866dadda32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/examples/ChangePointDetect.json @@ -0,0 +1,1569 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": { + "series": [ + { + "timestamp": "2017-01-01T06:45:00Z", + "value": 1639196 + }, + { + "timestamp": "2017-01-01T06:50:00Z", + "value": 1639290 + }, + { + "timestamp": "2017-01-01T06:55:00Z", + "value": 1667293 + }, + { + "timestamp": "2017-01-01T07:00:00Z", + "value": 1703130 + }, + { + "timestamp": "2017-01-01T07:05:00Z", + "value": 1650912 + }, + { + "timestamp": "2017-01-01T07:10:00Z", + "value": 1653596 + }, + { + "timestamp": "2017-01-01T07:15:00Z", + "value": 1653793 + }, + { + "timestamp": "2017-01-01T07:20:00Z", + "value": 1653795 + }, + { + "timestamp": "2017-01-01T07:25:00Z", + "value": 1663471 + }, + { + "timestamp": "2017-01-01T07:30:00Z", + "value": 1662358 + }, + { + "timestamp": "2017-01-01T07:35:00Z", + "value": 1664320 + }, + { + "timestamp": "2017-01-01T07:40:00Z", + "value": 1664942 + }, + { + "timestamp": "2017-01-01T07:45:00Z", + "value": 1664966 + }, + { + "timestamp": "2017-01-01T07:50:00Z", + "value": 1724271 + }, + { + "timestamp": "2017-01-01T07:55:00Z", + "value": 1678720 + }, + { + "timestamp": "2017-01-01T08:00:00Z", + "value": 1672536 + }, + { + "timestamp": "2017-01-01T08:05:00Z", + "value": 1672544 + }, + { + "timestamp": "2017-01-01T08:10:00Z", + "value": 1672364 + }, + { + "timestamp": "2017-01-01T08:15:00Z", + "value": 1672912 + }, + { + "timestamp": "2017-01-01T08:20:00Z", + "value": 1672736 + }, + { + "timestamp": "2017-01-01T08:25:00Z", + "value": 1672725 + }, + { + "timestamp": "2017-01-01T08:30:00Z", + "value": 1673247 + }, + { + "timestamp": "2017-01-01T08:35:00Z", + "value": 1673109 + }, + { + "timestamp": "2017-01-01T08:40:00Z", + "value": 1690088 + }, + { + "timestamp": "2017-01-01T08:45:00Z", + "value": 1703865 + }, + { + "timestamp": "2017-01-01T08:50:00Z", + "value": 1703865 + }, + { + "timestamp": "2017-01-01T08:55:00Z", + "value": 1786581 + }, + { + "timestamp": "2017-01-01T09:00:00Z", + "value": 1800945 + }, + { + "timestamp": "2017-01-01T09:05:00Z", + "value": 1800957 + }, + { + "timestamp": "2017-01-01T09:10:00Z", + "value": 1801191 + }, + { + "timestamp": "2017-01-01T09:15:00Z", + "value": 1801412 + }, + { + "timestamp": "2017-01-01T09:20:00Z", + "value": 1801621 + }, + { + "timestamp": "2017-01-01T09:25:00Z", + "value": 1801621 + }, + { + "timestamp": "2017-01-01T09:30:00Z", + "value": 1801654 + }, + { + "timestamp": "2017-01-01T09:35:00Z", + "value": 1802105 + }, + { + "timestamp": "2017-01-01T09:40:00Z", + "value": 1801800 + }, + { + "timestamp": "2017-01-01T09:45:00Z", + "value": 1803040 + }, + { + "timestamp": "2017-01-01T09:50:00Z", + "value": 1803672 + }, + { + "timestamp": "2017-01-01T09:55:00Z", + "value": 1803535 + }, + { + "timestamp": "2017-01-01T10:00:00Z", + "value": 1803541 + }, + { + "timestamp": "2017-01-01T10:05:00Z", + "value": 1803545 + }, + { + "timestamp": "2017-01-01T10:10:00Z", + "value": 1803599 + }, + { + "timestamp": "2017-01-01T10:15:00Z", + "value": 1803616 + }, + { + "timestamp": "2017-01-01T10:20:00Z", + "value": 1803619 + }, + { + "timestamp": "2017-01-01T10:25:00Z", + "value": 1809942 + }, + { + "timestamp": "2017-01-01T10:30:00Z", + "value": 1802720 + }, + { + "timestamp": "2017-01-01T10:35:00Z", + "value": 1802720 + }, + { + "timestamp": "2017-01-01T10:40:00Z", + "value": 1802888 + }, + { + "timestamp": "2017-01-01T10:45:00Z", + "value": 1809574 + }, + { + "timestamp": "2017-01-01T10:50:00Z", + "value": 1803896 + }, + { + "timestamp": "2017-01-01T10:55:00Z", + "value": 1803850 + }, + { + "timestamp": "2017-01-01T11:00:00Z", + "value": 1803854 + }, + { + "timestamp": "2017-01-01T11:05:00Z", + "value": 1803854 + }, + { + "timestamp": "2017-01-01T11:10:00Z", + "value": 1803797 + }, + { + "timestamp": "2017-01-01T11:15:00Z", + "value": 1803921 + }, + { + "timestamp": "2017-01-01T11:20:00Z", + "value": 1803933 + }, + { + "timestamp": "2017-01-01T11:25:00Z", + "value": 1804040 + }, + { + "timestamp": "2017-01-01T11:30:00Z", + "value": 1804044 + }, + { + "timestamp": "2017-01-01T11:35:00Z", + "value": 1804070 + }, + { + "timestamp": "2017-01-01T11:40:00Z", + "value": 1804070 + }, + { + "timestamp": "2017-01-01T11:45:00Z", + "value": 1804068 + }, + { + "timestamp": "2017-01-01T11:50:00Z", + "value": 1804073 + }, + { + "timestamp": "2017-01-01T11:55:00Z", + "value": 1804101 + }, + { + "timestamp": "2017-01-01T12:00:00Z", + "value": 1804674 + }, + { + "timestamp": "2017-01-01T12:05:00Z", + "value": 1804714 + }, + { + "timestamp": "2017-01-01T12:10:00Z", + "value": 1804730 + }, + { + "timestamp": "2017-01-01T12:15:00Z", + "value": 1804816 + }, + { + "timestamp": "2017-01-01T12:20:00Z", + "value": 1803996 + }, + { + "timestamp": "2017-01-01T12:25:00Z", + "value": 1803998 + }, + { + "timestamp": "2017-01-01T12:30:00Z", + "value": 1804015 + }, + { + "timestamp": "2017-01-01T12:35:00Z", + "value": 1804047 + }, + { + "timestamp": "2017-01-01T12:40:00Z", + "value": 1804050 + }, + { + "timestamp": "2017-01-01T12:45:00Z", + "value": 1804218 + }, + { + "timestamp": "2017-01-01T12:50:00Z", + "value": 1804217 + }, + { + "timestamp": "2017-01-01T12:55:00Z", + "value": 1804217 + }, + { + "timestamp": "2017-01-01T13:00:00Z", + "value": 1804205 + }, + { + "timestamp": "2017-01-01T13:05:00Z", + "value": 1804728 + }, + { + "timestamp": "2017-01-01T13:10:00Z", + "value": 1804748 + }, + { + "timestamp": "2017-01-01T13:15:00Z", + "value": 1805232 + }, + { + "timestamp": "2017-01-01T13:20:00Z", + "value": 1814121 + }, + { + "timestamp": "2017-01-01T13:25:00Z", + "value": 1806789 + }, + { + "timestamp": "2017-01-01T13:30:00Z", + "value": 1806119 + }, + { + "timestamp": "2017-01-01T13:35:00Z", + "value": 1806329 + }, + { + "timestamp": "2017-01-01T13:40:00Z", + "value": 1806454 + }, + { + "timestamp": "2017-01-01T13:45:00Z", + "value": 1806852 + }, + { + "timestamp": "2017-01-01T13:50:00Z", + "value": 1807347 + }, + { + "timestamp": "2017-01-01T13:55:00Z", + "value": 1812144 + }, + { + "timestamp": "2017-01-01T14:00:00Z", + "value": 1807418 + }, + { + "timestamp": "2017-01-01T14:05:00Z", + "value": 1807418 + }, + { + "timestamp": "2017-01-01T14:10:00Z", + "value": 1807432 + }, + { + "timestamp": "2017-01-01T14:15:00Z", + "value": 1808540 + }, + { + "timestamp": "2017-01-01T14:20:00Z", + "value": 1808541 + }, + { + "timestamp": "2017-01-01T14:25:00Z", + "value": 1807831 + }, + { + "timestamp": "2017-01-01T14:30:00Z", + "value": 1807852 + }, + { + "timestamp": "2017-01-01T14:35:00Z", + "value": 1807811 + }, + { + "timestamp": "2017-01-01T14:40:00Z", + "value": 2214285 + }, + { + "timestamp": "2017-01-01T14:45:00Z", + "value": 2215019 + }, + { + "timestamp": "2017-01-01T14:50:00Z", + "value": 2215329 + }, + { + "timestamp": "2017-01-01T14:55:00Z", + "value": 2215097 + }, + { + "timestamp": "2017-01-01T15:00:00Z", + "value": 2215129 + }, + { + "timestamp": "2017-01-01T15:05:00Z", + "value": 2215120 + }, + { + "timestamp": "2017-01-01T15:10:00Z", + "value": 2217056 + }, + { + "timestamp": "2017-01-01T15:15:00Z", + "value": 2217056 + }, + { + "timestamp": "2017-01-01T15:20:00Z", + "value": 2222126 + }, + { + "timestamp": "2017-01-01T15:25:00Z", + "value": 2226472 + }, + { + "timestamp": "2017-01-01T15:30:00Z", + "value": 2226722 + }, + { + "timestamp": "2017-01-01T15:35:00Z", + "value": 2226729 + }, + { + "timestamp": "2017-01-01T15:40:00Z", + "value": 2226735 + }, + { + "timestamp": "2017-01-01T15:45:00Z", + "value": 2226735 + }, + { + "timestamp": "2017-01-01T15:50:00Z", + "value": 2226735 + }, + { + "timestamp": "2017-01-01T15:55:00Z", + "value": 2226952 + }, + { + "timestamp": "2017-01-01T16:00:00Z", + "value": 2226962 + }, + { + "timestamp": "2017-01-01T16:05:00Z", + "value": 2649337 + }, + { + "timestamp": "2017-01-01T16:10:00Z", + "value": 2092796 + }, + { + "timestamp": "2017-01-01T16:15:00Z", + "value": 2092839 + }, + { + "timestamp": "2017-01-01T16:20:00Z", + "value": 2092940 + }, + { + "timestamp": "2017-01-01T16:25:00Z", + "value": 2092940 + }, + { + "timestamp": "2017-01-01T16:30:00Z", + "value": 2092965 + }, + { + "timestamp": "2017-01-01T16:35:00Z", + "value": 2092979 + }, + { + "timestamp": "2017-01-01T16:40:00Z", + "value": 2095588 + }, + { + "timestamp": "2017-01-01T16:45:00Z", + "value": 2099586 + }, + { + "timestamp": "2017-01-01T16:50:00Z", + "value": 2102981 + }, + { + "timestamp": "2017-01-01T16:55:00Z", + "value": 2108053 + }, + { + "timestamp": "2017-01-01T17:00:00Z", + "value": 2107907 + }, + { + "timestamp": "2017-01-01T17:05:00Z", + "value": 2108241 + }, + { + "timestamp": "2017-01-01T17:10:00Z", + "value": 2100321 + }, + { + "timestamp": "2017-01-01T17:15:00Z", + "value": 2100448 + }, + { + "timestamp": "2017-01-01T17:20:00Z", + "value": 2100483 + }, + { + "timestamp": "2017-01-01T17:25:00Z", + "value": 2103042 + }, + { + "timestamp": "2017-01-01T17:30:00Z", + "value": 2103037 + }, + { + "timestamp": "2017-01-01T17:35:00Z", + "value": 2103040 + }, + { + "timestamp": "2017-01-01T17:40:00Z", + "value": 2103054 + }, + { + "timestamp": "2017-01-01T17:45:00Z", + "value": 2103058 + }, + { + "timestamp": "2017-01-01T17:50:00Z", + "value": 1830757 + }, + { + "timestamp": "2017-01-01T17:55:00Z", + "value": 1830855 + }, + { + "timestamp": "2017-01-01T18:00:00Z", + "value": 1831495 + }, + { + "timestamp": "2017-01-01T18:05:00Z", + "value": 1831463 + }, + { + "timestamp": "2017-01-01T18:10:00Z", + "value": 1831963 + }, + { + "timestamp": "2017-01-01T18:15:00Z", + "value": 1832046 + }, + { + "timestamp": "2017-01-01T18:20:00Z", + "value": 1832070 + }, + { + "timestamp": "2017-01-01T18:25:00Z", + "value": 1835511 + }, + { + "timestamp": "2017-01-01T18:30:00Z", + "value": 1835265 + }, + { + "timestamp": "2017-01-01T18:35:00Z", + "value": 1835481 + }, + { + "timestamp": "2017-01-01T18:40:00Z", + "value": 1835578 + }, + { + "timestamp": "2017-01-01T18:45:00Z", + "value": 1835611 + }, + { + "timestamp": "2017-01-01T18:50:00Z", + "value": 1836314 + }, + { + "timestamp": "2017-01-01T18:55:00Z", + "value": 1836369 + }, + { + "timestamp": "2017-01-01T19:00:00Z", + "value": 1837280 + }, + { + "timestamp": "2017-01-01T19:05:00Z", + "value": 1842939 + }, + { + "timestamp": "2017-01-01T19:10:00Z", + "value": 1843126 + }, + { + "timestamp": "2017-01-01T19:15:00Z", + "value": 1845840 + }, + { + "timestamp": "2017-01-01T19:20:00Z", + "value": 1842444 + }, + { + "timestamp": "2017-01-01T19:25:00Z", + "value": 1839891 + }, + { + "timestamp": "2017-01-01T19:30:00Z", + "value": 1839875 + }, + { + "timestamp": "2017-01-01T19:35:00Z", + "value": 1839870 + }, + { + "timestamp": "2017-01-01T19:40:00Z", + "value": 1840090 + }, + { + "timestamp": "2017-01-01T19:45:00Z", + "value": 1840479 + }, + { + "timestamp": "2017-01-01T19:50:00Z", + "value": 1840479 + }, + { + "timestamp": "2017-01-01T19:55:00Z", + "value": 1840482 + }, + { + "timestamp": "2017-01-01T20:00:00Z", + "value": 1841522 + }, + { + "timestamp": "2017-01-01T20:05:00Z", + "value": 1841836 + }, + { + "timestamp": "2017-01-01T20:10:00Z", + "value": 1842377 + }, + { + "timestamp": "2017-01-01T20:15:00Z", + "value": 1842388 + }, + { + "timestamp": "2017-01-01T20:20:00Z", + "value": 1842489 + }, + { + "timestamp": "2017-01-01T20:25:00Z", + "value": 1842489 + }, + { + "timestamp": "2017-01-01T20:30:00Z", + "value": 1842489 + }, + { + "timestamp": "2017-01-01T20:35:00Z", + "value": 1842496 + }, + { + "timestamp": "2017-01-01T20:40:00Z", + "value": 1842689 + }, + { + "timestamp": "2017-01-01T20:45:00Z", + "value": 1843117 + }, + { + "timestamp": "2017-01-01T20:50:00Z", + "value": 1843116 + }, + { + "timestamp": "2017-01-01T20:55:00Z", + "value": 1843227 + }, + { + "timestamp": "2017-01-01T21:00:00Z", + "value": 1843138 + }, + { + "timestamp": "2017-01-01T21:05:00Z", + "value": 1843141 + }, + { + "timestamp": "2017-01-01T21:10:00Z", + "value": 1843310 + }, + { + "timestamp": "2017-01-01T21:15:00Z", + "value": 1843310 + }, + { + "timestamp": "2017-01-01T21:20:00Z", + "value": 1843507 + }, + { + "timestamp": "2017-01-01T21:25:00Z", + "value": 1843953 + }, + { + "timestamp": "2017-01-01T21:30:00Z", + "value": 1844778 + }, + { + "timestamp": "2017-01-01T21:35:00Z", + "value": 1843918 + }, + { + "timestamp": "2017-01-01T21:40:00Z", + "value": 1882692 + }, + { + "timestamp": "2017-01-01T21:45:00Z", + "value": 1974888 + }, + { + "timestamp": "2017-01-01T21:50:00Z", + "value": 2157136 + }, + { + "timestamp": "2017-01-01T21:55:00Z", + "value": 2154987 + }, + { + "timestamp": "2017-01-01T22:00:00Z", + "value": 2155664 + }, + { + "timestamp": "2017-01-01T22:05:00Z", + "value": 2155660 + }, + { + "timestamp": "2017-01-01T22:10:00Z", + "value": 2155824 + }, + { + "timestamp": "2017-01-01T22:15:00Z", + "value": 2155824 + }, + { + "timestamp": "2017-01-01T22:20:00Z", + "value": 2156329 + }, + { + "timestamp": "2017-01-01T22:25:00Z", + "value": 2156479 + }, + { + "timestamp": "2017-01-01T22:30:00Z", + "value": 2165269 + }, + { + "timestamp": "2017-01-01T22:35:00Z", + "value": 2165433 + }, + { + "timestamp": "2017-01-01T22:40:00Z", + "value": 2165739 + }, + { + "timestamp": "2017-01-01T22:45:00Z", + "value": 2165931 + }, + { + "timestamp": "2017-01-01T22:50:00Z", + "value": 2165928 + }, + { + "timestamp": "2017-01-01T22:55:00Z", + "value": 2165989 + }, + { + "timestamp": "2017-01-01T23:00:00Z", + "value": 2228961 + }, + { + "timestamp": "2017-01-01T23:05:00Z", + "value": 2228961 + }, + { + "timestamp": "2017-01-01T23:10:00Z", + "value": 2228961 + }, + { + "timestamp": "2017-01-01T23:15:00Z", + "value": 2485802 + }, + { + "timestamp": "2017-01-01T23:20:00Z", + "value": 2485802 + }, + { + "timestamp": "2017-01-01T23:25:00Z", + "value": 2486021 + }, + { + "timestamp": "2017-01-01T23:30:00Z", + "value": 2485293 + }, + { + "timestamp": "2017-01-01T23:35:00Z", + "value": 2485293 + }, + { + "timestamp": "2017-01-01T23:40:00Z", + "value": 2485324 + }, + { + "timestamp": "2017-01-01T23:45:00Z", + "value": 2489142 + }, + { + "timestamp": "2017-01-01T23:50:00Z", + "value": 2526312 + }, + { + "timestamp": "2017-01-01T23:55:00Z", + "value": 2526313 + }, + { + "timestamp": "2017-01-02T00:00:00Z", + "value": 2526314 + }, + { + "timestamp": "2017-01-02T00:05:00Z", + "value": 2526324 + }, + { + "timestamp": "2017-01-02T00:10:00Z", + "value": 2526325 + }, + { + "timestamp": "2017-01-02T00:15:00Z", + "value": 2526205 + }, + { + "timestamp": "2017-01-02T00:20:00Z", + "value": 2526226 + }, + { + "timestamp": "2017-01-02T00:25:00Z", + "value": 2526475 + }, + { + "timestamp": "2017-01-02T00:30:00Z", + "value": 2526471 + }, + { + "timestamp": "2017-01-02T00:35:00Z", + "value": 2526471 + }, + { + "timestamp": "2017-01-02T00:40:00Z", + "value": 2526534 + }, + { + "timestamp": "2017-01-02T00:45:00Z", + "value": 2526646 + }, + { + "timestamp": "2017-01-02T00:50:00Z", + "value": 2526646 + }, + { + "timestamp": "2017-01-02T00:55:00Z", + "value": 2526648 + }, + { + "timestamp": "2017-01-02T01:00:00Z", + "value": 2526658 + }, + { + "timestamp": "2017-01-02T01:05:00Z", + "value": 2526771 + }, + { + "timestamp": "2017-01-02T01:10:00Z", + "value": 2526773 + }, + { + "timestamp": "2017-01-02T01:15:00Z", + "value": 2526793 + }, + { + "timestamp": "2017-01-02T01:20:00Z", + "value": 2527010 + }, + { + "timestamp": "2017-01-02T01:25:00Z", + "value": 2527031 + }, + { + "timestamp": "2017-01-02T01:30:00Z", + "value": 3178096 + }, + { + "timestamp": "2017-01-02T01:35:00Z", + "value": 3196305 + }, + { + "timestamp": "2017-01-02T01:40:00Z", + "value": 3196202 + }, + { + "timestamp": "2017-01-02T01:45:00Z", + "value": 3196202 + }, + { + "timestamp": "2017-01-02T01:50:00Z", + "value": 3196205 + }, + { + "timestamp": "2017-01-02T01:55:00Z", + "value": 3229232 + }, + { + "timestamp": "2017-01-02T02:00:00Z", + "value": 3230463 + }, + { + "timestamp": "2017-01-02T02:05:00Z", + "value": 3230468 + }, + { + "timestamp": "2017-01-02T02:10:00Z", + "value": 3230468 + }, + { + "timestamp": "2017-01-02T02:15:00Z", + "value": 3230468 + }, + { + "timestamp": "2017-01-02T02:20:00Z", + "value": 3230470 + }, + { + "timestamp": "2017-01-02T02:25:00Z", + "value": 3230467 + }, + { + "timestamp": "2017-01-02T02:30:00Z", + "value": 3230506 + }, + { + "timestamp": "2017-01-02T02:35:00Z", + "value": 3231536 + }, + { + "timestamp": "2017-01-02T02:40:00Z", + "value": 3230723 + }, + { + "timestamp": "2017-01-02T02:45:00Z", + "value": 3230727 + }, + { + "timestamp": "2017-01-02T02:50:00Z", + "value": 3230727 + }, + { + "timestamp": "2017-01-02T02:55:00Z", + "value": 3230727 + }, + { + "timestamp": "2017-01-02T03:00:00Z", + "value": 3231880 + }, + { + "timestamp": "2017-01-02T03:05:00Z", + "value": 3232283 + }, + { + "timestamp": "2017-01-02T03:10:00Z", + "value": 3232283 + }, + { + "timestamp": "2017-01-02T03:15:00Z", + "value": 3232283 + }, + { + "timestamp": "2017-01-02T03:20:00Z", + "value": 3232325 + }, + { + "timestamp": "2017-01-02T03:25:00Z", + "value": 3232323 + }, + { + "timestamp": "2017-01-02T03:30:00Z", + "value": 3232327 + }, + { + "timestamp": "2017-01-02T03:35:00Z", + "value": 3232340 + }, + { + "timestamp": "2017-01-02T03:40:00Z", + "value": 3232713 + }, + { + "timestamp": "2017-01-02T03:45:00Z", + "value": 3232729 + }, + { + "timestamp": "2017-01-02T03:50:00Z", + "value": 3232756 + }, + { + "timestamp": "2017-01-02T03:55:00Z", + "value": 3233500 + }, + { + "timestamp": "2017-01-02T04:00:00Z", + "value": 3233500 + }, + { + "timestamp": "2017-01-02T04:05:00Z", + "value": 3233500 + } + ], + "granularity": "minutely", + "customInterval": 5, + "stableTrendWindow": 10, + "threshold": 0.99, + "period": 0 + } + }, + "responses": { + "200": { + "body": { + "period": 0, + "confidenceScores": [ + 0.11841763735063232, + 0.014857199927548581, + 0.0887032374955278, + 0.07430314751946857, + 0.059903057543409355, + 0.04132288981790399, + 0.022742722092391268, + 0.0005683208474757854, + 0.0216060803974397, + 0.053248991089971616, + 0.08489190178249614, + 0.04322511558132514, + 0.085336620199234, + 0.05876047041512903, + 0.02673755265447302, + 0.005032027060762012, + 0.031323171543775764, + 0.06299774949197792, + 0.08944723025337244, + 0.11523169864554421, + 0.14288453512268834, + 0.001592562559717675, + 0.32637788222282893, + 0, + 7.37310752217245e-15, + 2.211932256651735e-14, + 1, + 0.015697015891758138, + 0.01242773215043403, + 0.016188579169534697, + 0.019537751864826272, + 0.022506917491993753, + 0.01885762668253081, + 0.016253355310429398, + 0.017227483829906676, + 0.023236706002118527, + 0.03906277743439327, + 0.0354134866249377, + 0.037084294769315296, + 0.038248426822850935, + 0.050274427573818385, + 0.046815140298421175, + 0.043292518511668716, + 0.041353259508804745, + 0.038242312045861385, + 0.0346880230034313, + 0.032717096744889713, + 0.033026212895129546, + 0.031055286636580585, + 0.0275326648498355, + 0.023883374040372555, + 0.021564107969369743, + 0.018706498551854727, + 0.01543721481052325, + 0.015176320358565887, + 0.011527029549110314, + 0.008004407762357859, + 0.004355116952902286, + 0.0007058261434393403, + 0.0030701336887340946, + 0.006592755475479178, + 0.010147044517909256, + 0.013701333560339335, + 0.016780613767597707, + 0.020366570065705403, + 0.024015860875168354, + 0.02757014991759106, + 0.03033275756808058, + 0.03068865378707081, + 0.03395793752839492, + 0.03760722833785786, + 0.04122485189164318, + 0.030433874112103007, + 0.032816474694461056, + 0.03602242392443729, + 0.03960838022253762, + 0.04268766042980336, + 0.04633695123926631, + 0.0346592903007527, + 0.010219725324164698, + 0.007218892441326965, + 0.006909776291079754, + 0.000049463551460760754, + 0.0016047901503119819, + 0.01042121060065547, + 0.009020294944303705, + 0.005371004134840759, + 0.0021650549048718984, + 0.010517653997227793, + 0.0075017083013172925, + 0.00385241749186172, + 0.0008681390516288423, + 0.019005920148370017, + 0.015388296594592068, + 0.12583612799160215, + 1, + 0.005055878353042495, + 0.007613932468790628, + 0.011913685646822731, + 0.0166567804043268, + 0.015351429327405014, + 0.034309821169245976, + 0.0292817211106433, + 0.02425362105202589, + 0.019225520993423218, + 0.01419742093482055, + 0.00916932087621788, + 0.004141220817600464, + 0.0008868792410022057, + 0.0059149792996048755, + 0.010943079358207547, + 0.015971179416810213, + 0.02099927947542763, + 1, + 0.11533376425564247, + 0.1207645081246342, + 0.025174230145423273, + 0.09422487163021387, + 0.08417070843230404, + 0.07411654523437947, + 0.06406238203646963, + 0.0540082188385598, + 0.04395405564064997, + 0.03500824639144218, + 0.024954083193532338, + 0.014899919995622513, + 0.004845756797712681, + 0.005208406400211895, + 0.015262569598121728, + 0.025316732796031558, + 0.03537089599394139, + 0.045425059191865964, + 0.05145748091871777, + 1, + 0.011663506282381296, + 0.0043856580970499884, + 0.002892190088273945, + 0.01017003827359788, + 0.01744788645892181, + 0.024725734644253115, + 0.03200358282957705, + 0.03928143101490098, + 0.046559279200224915, + 0.05383712738555622, + 0.060069956133518614, + 0.0450857235774741, + 0.050621872700536176, + 0.029050850963546225, + 0.045689493056171517, + 0.0385699811492357, + 0.03179880905474635, + 0.03082274474926925, + 0.03586345902254038, + 0.028585610837209074, + 0.021402764418918006, + 0.04705886213832124, + 0.049724532235770696, + 0.05957866937203304, + 0.052649160999162954, + 0.045371312813839014, + 0.03809346462851508, + 0.030815616443183775, + 0.023537768257859845, + 0.01945831289597576, + 0.012180464710644455, + 0.00490261652532052, + 0.002153560870260057, + 0.0033196287098028916, + 0.0029244412792105113, + 0.0043217396504358, + 0.010934575466529664, + 0.018117421884820732, + 0.02267188608187652, + 0.027321352045957807, + 0.03459920023128174, + 0.03563859904812146, + 0.02990120514994264, + 0.03607069938654979, + 0.017223061637835352, + 7.37310752217245e-15, + 1.47462150443449e-14, + 1, + 0.046440552438977135, + 0.012233652454378385, + 0.017033155644526038, + 0.05136672465183527, + 0.06970832954194527, + 0.09929181019761117, + 0.11281999222473732, + 0.11039622919405537, + 0.08125609011787617, + 0.05661270134791935, + 0.028264243663680723, + 0.005974323576610399, + 0.038471191754617544, + 0, + 0, + 0, + 0.020288532128574968, + 0.005041879493223223, + 0.009223088216122232, + 0.009332792637570532, + 0.024579445272937026, + 0.03289096891488949, + 0.050695883419617865, + 1, + 0.000748013913075547, + 0.002186373999917361, + 0.0009330173541465358, + 0.00032033929162428933, + 0.0012886906362965138, + 0.002542047282052593, + 0.0007963481454318109, + 0.0004886757560166365, + 0.0016470306347398486, + 0.001063686451208582, + 0.0011980222832366648, + 0.00008700161821178273, + 0.0013086910082902394, + 0.0022770423529624643, + 0.000016333637160404937, + 0.0012053557529180517, + 0.0018570345408140537, + 0.0037297360397815314, + 0.003109724507563151, + 0.22869458705263188, + 0.2293374323429407, + 0.1140021204394844, + 0.0012381896969537412, + 0.11340677603264777, + 1, + 0.011793249472519423, + 0.008293225072094536, + 0.00469819890465153, + 0.0010715054815308995, + 0.0025551879416044767, + 0.006118546853369862, + 0.008605219072110835, + 0.0053601180131874334, + 0.008860142413597574, + 0.01248683583673295, + 0.01611352925985358, + 0.005878587160222206, + 0.013145429690188892, + 0.022280640305150038, + 0.01865394688201466, + 0.015027253458894031, + 0.012033905149325846, + 0.009040556839742916, + 0.005445530672299909, + 0.0018505045048569009, + 0.001744521662600853, + 0.005339547830043862, + 0.008760404091259945, + 0.012181260352490777, + 0.009902010591734853, + 0.007622760830993676 + ], + "isChangePoint": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md index b09563822d24..585ec17fb952 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md @@ -74,6 +74,7 @@ java: output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/anomalydetector with-optional-parameters: true with-single-async-method: true + regenerate-manager: true ``` ## Multi-API/Profile support for AutoRest v3 generators diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json index 3a95b0c412a3..eb48fae13c61 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json @@ -15,61 +15,61 @@ }, "suggestionGroups": [ { - "_type": "Suggestions\/SuggestionGroup", + "_type": "Suggestions/SuggestionGroup", "name": "Web", "searchSuggestions": [ { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=amazon&FORM=USBAPI", + "url": "https://www.bing.com/search?q=amazon&FORM=USBAPI", "displayText": "amazon", "query": "amazon", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=alaska+airlines&FORM=USBAPI", + "url": "https://www.bing.com/search?q=alaska+airlines&FORM=USBAPI", "displayText": "alaska airlines", "query": "alaska airlines", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=aol&FORM=USBAPI", + "url": "https://www.bing.com/search?q=aol&FORM=USBAPI", "displayText": "aol", "query": "aol", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=amazon+prime&FORM=USBAPI", + "url": "https://www.bing.com/search?q=amazon+prime&FORM=USBAPI", "displayText": "amazon prime", "query": "amazon prime", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=airbnb&FORM=USBAPI", + "url": "https://www.bing.com/search?q=airbnb&FORM=USBAPI", "displayText": "airbnb", "query": "airbnb", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=american+express&FORM=USBAPI", + "url": "https://www.bing.com/search?q=american+express&FORM=USBAPI", "displayText": "american express", "query": "american express", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=autotrader&FORM=USBAPI", + "url": "https://www.bing.com/search?q=autotrader&FORM=USBAPI", "displayText": "autotrader", "query": "autotrader", "searchKind": "WebSearch" }, { "_type": "SearchAction", - "url": "https:\/\/www.bing.com\/search?q=autozone&FORM=USBAPI", + "url": "https://www.bing.com/search?q=autozone&FORM=USBAPI", "displayText": "autozone", "query": "autozone", "searchKind": "WebSearch" diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md index 0af66e9e59e0..ab2308e427f7 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md @@ -17,6 +17,7 @@ batch: - tag: release_2_1 - tag: release_2_2 - tag: release_3_0 + - tag: release_3_1 ``` ### Tag: release_1_0 and go @@ -54,3 +55,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_1' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.1/customvision/$(namespace) +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md index 98e4db6d18b3..7015276594b4 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md @@ -14,6 +14,7 @@ azure-arm: true batch: - tag: release_1_0 - tag: release_3_0 + - tag: release_3_1 ``` ### Tag: release_1_0 and ruby @@ -37,3 +38,14 @@ namespace: "Azure::CognitiveServices::CustomVision::Training::V3_0" output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontraining/lib title: "TrainingClient" ``` + +### Tag: release_3_1 and ruby + +These settings apply only when `--tag=release_3_1 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_3_1' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Training::V3_1" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontraining/lib +title: "TrainingClient" +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json new file mode 100644 index 000000000000..44eaef160894 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/FormRecognizer.json @@ -0,0 +1,1380 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.0-preview", + "title": "Form Recognizer Client", + "description": "Extracts information from forms and images into structured data." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/formrecognizer/v2.0-preview", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/custom/models": { + "post": { + "summary": "Train Custom Model", + "description": "Create and train a custom model. The request must include a source parameter that is either an externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri) or valid path to a data folder in a locally mounted drive. When local paths are specified, they must follow the Linux/Unix path format and be an absolute path rooted to the input mount configuration setting value e.g., if '{Mounts:Input}' configuration setting value is '/input' then a valid source path would be '/input/contosodataset'. All data to be trained is expected to be under the source folder or sub folders under it. Models are trained using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff'. Other type of content is ignored.", + "operationId": "TrainCustomModelAsync", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "name": "trainRequest", + "in": "body", + "description": "Training request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TrainRequest" + } + } + ], + "responses": { + "201": { + "description": "Request is queued successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the model being trained. The status of model training is specified in the status property at the model location." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Train custom model": { + "$ref": "./examples/TrainBatch.json" + }, + "Train custom model with subfolder filter options": { + "$ref": "./examples/TrainBatchWithSubFolders.json" + } + } + }, + "get": { + "summary": "List Custom Models", + "description": "Get information about all custom models", + "operationId": "GetCustomModels", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "op", + "in": "query", + "description": "Specify whether to return summary or full list of models.", + "required": false, + "default": "full", + "type": "string", + "enum": [ + "full", + "summary" + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Models" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "modelList" + }, + "x-ms-examples": { + "List custom models": { + "$ref": "./examples/GetModels.json" + } + } + } + }, + "/custom/models/{modelId}": { + "get": { + "summary": "Get Custom Model", + "description": "Get detailed information about a custom model.", + "operationId": "GetCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeKeys", + "in": "query", + "description": "Include list of extracted keys in model information.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get custom model": { + "$ref": "./examples/GetModel.json" + } + } + }, + "delete": { + "summary": "Delete Custom Model", + "description": "Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.", + "operationId": "DeleteCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "Successfully marked model for deletion. Model artifacts will be removed within a predefined time period." + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete custom model": { + "$ref": "./examples/DeleteModel.json" + } + } + } + }, + "/custom/models/{modelId}/analyze": { + "post": { + "summary": "Analyze Form", + "description": "Extract key-value pairs, tables, and semantic values from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.", + "operationId": "AnalyzeWithCustomModel", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze form with custom model": { + "$ref": "./examples/AnalyzeBatch.json" + } + } + } + }, + "/custom/models/{modelId}/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Form Result", + "description": "Obtain current status and the result of the analyze form operation.", + "operationId": "GetAnalyzeFormResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze form result": { + "$ref": "./examples/AnalyzeOperationResult.json" + } + } + } + }, + "/prebuilt/receipt/analyze": { + "post": { + "summary": "Analyze Receipt", + "description": "Extract field text and semantic values from a given receipt document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.", + "operationId": "AnalyzeReceiptAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze receipt": { + "$ref": "./examples/ReceiptsBatch.json" + } + } + } + }, + "/prebuilt/receipt/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Receipt Result", + "description": "Track the progress and obtain the result of the analyze receipt operation.", + "operationId": "GetAnalyzeReceiptResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze receipt result": { + "$ref": "./examples/ReceiptsBatchResult.json" + } + } + } + }, + "/layout/analyze": { + "post": { + "summary": "Analyze Layout", + "description": "Extract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.", + "operationId": "AnalyzeLayoutAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze layout": { + "$ref": "./examples/LayoutBatch.json" + } + } + } + }, + "/layout/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Layout Result", + "description": "Track the progress and obtain the result of the analyze layout operation", + "operationId": "GetAnalyzeLayoutResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze layout result": { + "$ref": "./examples/LayoutBatchResult.json" + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "type": "string", + "description": "Status of the queued operation.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "AnalyzeOperationResult": { + "description": "Status and result of the queued analyze operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the analyze operation was submitted.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "analyzeResult": { + "description": "Results of the analyze operation.", + "$ref": "#/definitions/AnalyzeResult" + } + } + }, + "TrainRequest": { + "description": "Request parameter to train a new custom model.", + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "description": "Source path containing the training documents.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "sourceFilter": { + "$ref": "#/definitions/TrainSourceFilter", + "description": "Filter to apply to the documents in the source path for training." + }, + "useLabelFile": { + "description": "Use label file for training a model.", + "type": "boolean", + "default": false + } + } + }, + "TrainSourceFilter": { + "description": "Filter to apply to the documents in the source path for training.", + "type": "object", + "properties": { + "prefix": { + "description": "A case-sensitive prefix string to filter documents in the source path for training. For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for training.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "includeSubFolders": { + "description": "A flag to indicate if sub folders within the set of prefix folders will also need to be included when searching for content to be preprocessed.", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "TrainResult": { + "description": "Custom model training result.", + "type": "object", + "required": [ + "trainingDocuments" + ], + "properties": { + "trainingDocuments": { + "description": "List of the documents used to train the model and any errors reported in each document.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingDocumentInfo" + } + }, + "fields": { + "description": "List of fields used to train the model and the train operation error reported by each.", + "type": "array", + "items": { + "$ref": "#/definitions/FormFieldsReport" + } + }, + "averageModelAccuracy": { + "description": "Average accuracy.", + "type": "number", + "x-nullable": false + }, + "errors": { + "description": "Errors returned during the training operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "SourcePath": { + "description": "Uri or local path to source data.", + "type": "object", + "properties": { + "source": { + "description": "File source path.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + } + }, + "SourceDataStream": { + "description": "A PDF document, image (jpg/png/tiff), or JSON file to analyze.", + "type": "object" + }, + "ModelInfo": { + "description": "Basic custom model information.", + "type": "object", + "required": [ + "modelId", + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "status": { + "description": "Status of the model.", + "enum": [ + "creating", + "ready", + "invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the model was created.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + } + } + }, + "Models": { + "description": "Response to the list custom models operation.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of all trained custom models.", + "type": "object", + "required": [ + "count", + "limit", + "lastUpdatedDateTime" + ], + "properties": { + "count": { + "description": "Current count of trained custom models.", + "type": "integer", + "x-nullable": false + }, + "limit": { + "description": "Max number of models that can be trained for this subscription.", + "type": "integer", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the summary was last updated.", + "type": "string", + "x-nullable": false + } + } + }, + "modelList": { + "description": "Collection of trained custom models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfo" + } + }, + "nextLink": { + "description": "Link to the next page of custom models.", + "type": "string" + } + } + }, + "Model": { + "description": "Response to the get custom model operation.", + "type": "object", + "required": [ + "modelInfo" + ], + "properties": { + "modelInfo": { + "$ref": "#/definitions/ModelInfo" + }, + "keys": { + "$ref": "#/definitions/KeysResult" + }, + "trainResult": { + "$ref": "#/definitions/TrainResult" + } + } + }, + "KeysResult": { + "description": "Keys extracted by the custom model.", + "type": "object", + "required": [ + "clusters" + ], + "properties": { + "clusters": { + "description": "Object mapping clusterIds to a list of keys.", + "type": "object", + "additionalProperties": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string" + } + } + } + } + }, + "TrainingDocumentInfo": { + "description": "Report for a custom model training document.", + "type": "object", + "required": [ + "documentName", + "pages", + "errors", + "status" + ], + "properties": { + "documentName": { + "description": "Training document name.", + "type": "string" + }, + "pages": { + "format": "int32", + "description": "Total number of pages trained.", + "type": "integer", + "x-nullable": false + }, + "errors": { + "description": "List of errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + }, + "status": { + "description": "Status of the training operation.", + "enum": [ + "succeeded", + "partiallySucceeded", + "failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainStatus", + "modelAsString": false + }, + "x-nullable": false + } + } + }, + "FormFieldsReport": { + "description": "Report for a custom model training field.", + "type": "object", + "required": [ + "fieldName", + "accuracy" + ], + "properties": { + "fieldName": { + "description": "Training field name.", + "type": "string" + }, + "accuracy": { + "description": "Estimated extraction accuracy for this field.", + "type": "number", + "x-nullable": false + } + } + }, + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/definitions/ErrorInformation" + } + } + }, + "ErrorInformation": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "AnalyzeResult": { + "description": "Analyze operation result.", + "type": "object", + "required": [ + "version", + "readResults" + ], + "properties": { + "version": { + "description": "Version of schema used for this result.", + "type": "string" + }, + "readResults": { + "description": "Text extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/ReadResult" + } + }, + "pageResults": { + "description": "Page-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/PageResult" + } + }, + "documentResults": { + "description": "Document-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentResult" + } + }, + "errors": { + "description": "List of errors reported during the analyze operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "ReadResult": { + "description": "Text extracted from a page in the input document.", + "type": "object", + "required": [ + "page", + "angle", + "width", + "height", + "unit" + ], + "properties": { + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "angle": { + "description": "The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].", + "type": "number", + "minimum": -180, + "maximum": 180, + "exclusiveMinimum": true, + "x-nullable": false + }, + "width": { + "description": "The width of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "height": { + "description": "The height of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "unit": { + "description": "The unit used by the width, height and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", + "type": "string", + "enum": [ + "pixel", + "inch" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": false + }, + "x-nullable": false + }, + "language": { + "description": "The detected language on the page overall.", + "$ref": "#/definitions/Language" + }, + "lines": { + "description": "When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.", + "type": "array", + "items": { + "$ref": "#/definitions/TextLine" + } + } + } + }, + "Language": { + "description": "Language code", + "type": "string", + "enum": [ + "en", + "es" + ], + "x-ms-enum": { + "name": "Language", + "modelAsString": true + }, + "x-nullable": false + }, + "TextLine": { + "description": "An object representing an extracted text line.", + "type": "object", + "required": [ + "text", + "boundingBox", + "words" + ], + "properties": { + "text": { + "description": "The text content of the line.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted line.", + "$ref": "#/definitions/BoundingBox" + }, + "language": { + "description": "The detected language of this line, if different from the overall page language.", + "$ref": "#/definitions/Language" + }, + "words": { + "description": "List of words in the text line.", + "type": "array", + "items": { + "$ref": "#/definitions/TextWord" + } + } + } + }, + "TextWord": { + "description": "An object representing a word.", + "type": "object", + "required": [ + "boundingBox", + "text" + ], + "properties": { + "text": { + "description": "The text content of the word.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted word.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "BoundingBox": { + "description": "Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.", + "type": "array", + "minItems": 8, + "maxItems": 8, + "items": { + "type": "number", + "x-nullable": false + } + }, + "PageResult": { + "description": "Extracted information from a single page.", + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "description": "Page number.", + "type": "integer", + "format": "int32", + "minimum": 1, + "x-nullable": false + }, + "clusterId": { + "description": "Cluster identifier.", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": false + }, + "keyValuePairs": { + "description": "List of key-value pairs extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValuePair" + } + }, + "tables": { + "description": "List of data tables extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTable" + } + } + } + }, + "KeyValuePair": { + "description": "Information about the extracted key-value pair.", + "type": "object", + "required": [ + "key", + "value", + "confidence" + ], + "properties": { + "label": { + "description": "A user defined label for the key/value pair entry.", + "type": "string" + }, + "key": { + "description": "Information about the extracted key in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "value": { + "description": "Information about the extracted value in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "KeyValueElement": { + "description": "Information about the extracted key or value in a key-value pair.", + "type": "object", + "required": [ + "text" + ], + "properties": { + "text": { + "description": "The text content of the key or value.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the key or value.", + "$ref": "#/definitions/BoundingBox" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + } + } + }, + "ElementReference": { + "description": "Reference to a line or word.", + "type": "string" + }, + "DataTable": { + "description": "Information about the extracted table contained in a page.", + "type": "object", + "required": [ + "rows", + "columns", + "cells" + ], + "properties": { + "rows": { + "description": "Number of rows.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "columns": { + "description": "Number of columns.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "cells": { + "description": "List of cells contained in the table.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTableCell" + } + } + } + }, + "DataTableCell": { + "description": "Information about the extracted cell in a table.", + "type": "object", + "required": [ + "rowIndex", + "columnIndex", + "text", + "boundingBox", + "confidence" + ], + "properties": { + "rowIndex": { + "description": "Row index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "columnIndex": { + "description": "Column index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "rowSpan": { + "description": "Number of rows spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "columnSpan": { + "description": "Number of columns spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "text": { + "description": "Text content of the cell.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the cell.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this table cell.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "isHeader": { + "description": "Is the current cell a header cell?", + "type": "boolean", + "default": false, + "x-nullable": false + }, + "isFooter": { + "description": "Is the current cell a footer cell?", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "DocumentResult": { + "description": "A set of extracted fields corresponding to the input document.", + "required": [ + "docType", + "pageRange", + "fields" + ], + "properties": { + "docType": { + "description": "Document type.", + "type": "string" + }, + "pageRange": { + "description": "First and last page number where the document is found.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "integer", + "minimum": 1, + "x-nullable": false + } + }, + "fields": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + } + } + }, + "FieldValue": { + "description": "Recognized field value.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of field value.", + "$ref": "#/definitions/FieldValueType" + }, + "valueString": { + "description": "String value.", + "type": "string" + }, + "valueDate": { + "description": "Date value.", + "type": "string", + "format": "date-time", + "x-nullable": false + }, + "valueTime": { + "description": "Time value.", + "type": "string", + "format": "date-time", + "x-nullable": false + }, + "valuePhoneNumber": { + "description": "Phone number value.", + "type": "string" + }, + "valueNumber": { + "description": "Floating point value.", + "type": "number", + "x-nullable": false + }, + "valueInteger": { + "description": "Integer value.", + "type": "integer", + "x-nullable": false + }, + "valueArray": { + "description": "Array of field values.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + }, + "valueObject": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + }, + "text": { + "description": "Text content of the extracted field.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the field value, if appropriate.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence score.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this field.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + } + } + }, + "FieldValueType": { + "type": "string", + "description": "Semantic data type of the field value.", + "enum": [ + "string", + "date", + "time", + "phoneNumber", + "number", + "integer", + "array", + "object" + ], + "x-ms-enum": { + "name": "FieldValueType", + "modelAsString": false + }, + "x-nullable": false + }, + "Confidence": { + "description": "Confidence value.", + "type": "number", + "minimum": 0, + "maximum": 1, + "x-nullable": false + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "FileStream": { + "name": "fileStream", + "description": ".json, .pdf, .jpg, .png or .tiff type file stream.", + "x-ms-parameter-location": "method", + "in": "body", + "schema": { + "$ref": "#/definitions/SourceDataStream" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeBatch.json new file mode 100644 index 000000000000..82886aff5613 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{Model Id}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.0-preview/custom/models/{modelId}/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeOperationResult.json new file mode 100644 index 000000000000..ac3e01056b61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/AnalyzeOperationResult.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{model Id}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.0", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/DeleteModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/DeleteModel.json new file mode 100644 index 000000000000..8033b6772479 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/DeleteModel.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{Model Id}", + "body": {} + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModel.json new file mode 100644 index 000000000000..3a34fea1ae13 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModel.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{Model Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "modelInfo": { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z" + }, + "keys": { + "clusters": { + "0": [ + "Invoice", + "123112313" + ], + "1": [ + "Please remit payment to:", + "Microsoft" + ] + } + }, + "trainResult": { + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModels.json new file mode 100644 index 000000000000..1ebb45e86268 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/GetModels.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "op": "full", + "body": {} + }, + "responses": { + "200": { + "body": { + "summary": { + "count": 5, + "limit": 5000, + "lastUpdatedDateTime": "2019-05-01T10:53:21Z" + }, + "modelList": [ + { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z" + }, + { + "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatch.json new file mode 100644 index 000000000000..653d97348f96 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "language": "en", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.0-preview/layout/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatchResult.json new file mode 100644 index 000000000000..099b8a2df49a --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/LayoutBatchResult.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{model Id}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.0", + "readResults": [], + "pageResults": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatch.json new file mode 100644 index 000000000000..9b5b2ba0f8dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatch.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.0-preview/prebuilt/receipt/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatchResult.json new file mode 100644 index 000000000000..ac3e01056b61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/ReceiptsBatchResult.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{model Id}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.0", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatch.json new file mode 100644 index 000000000000..e46593143196 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.0-preview/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatchWithSubFolders.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatchWithSubFolders.json new file mode 100644 index 000000000000..d802556456f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.0/examples/TrainBatchWithSubFolders.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1", + "sourceFilter": { + "prefix": "", + "includeSubFolders": false + }, + "useLabelFile": false + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.0-preview/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md index 1ecb8d09f9fa..969d24a80c96 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md +++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md @@ -4,7 +4,14 @@ Configuration for generating Form Recognizer SDK. -The current release is `release_1_0`. +The current release is `release_2_0`. + +``` yaml + +tag: release_2_0 +add-credentials: true +openapi-type: data-plane +``` ``` yaml @@ -14,6 +21,14 @@ openapi-type: data-plane ``` # Releases +### Release 2.0 +These settings apply only when `--tag=release_2_0` is specified on the command line. + +``` yaml $(tag) == 'release_2_0' +input-file: + - preview/v2.0/FormRecognizer.json +``` + ### Release 1.0 These settings apply only when `--tag=release_1_0` is specified on the command line. @@ -86,6 +101,7 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/preview/v2.0/FormRecognizer.json - $(this-folder)/preview/v1.0/FormRecognizer.json - $(this-folder)/preview/v1.0/FormRecognizerReceipt.json - $(this-folder)/preview/v1.0/FormRecognizerReceiptOcr.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json new file mode 100644 index 000000000000..3e3f69a10681 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json @@ -0,0 +1,10443 @@ +{ + "swagger": "2.0", + "info": { + "title": "LUIS Authoring Client", + "version": "3.0-preview" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/luis/authoring/v3.0-preview", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/apps/{appId}/versions/{versionId}/phraselists": { + "post": { + "description": "Creates a new phraselist feature in a version of the application.", + "operationId": "Features_AddPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PhraselistCreateObject" + }, + "description": "A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created feature.", + "schema": { + "$ref": "#/definitions/FeatureIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Phraselist Feature request": { + "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" + } + } + }, + "get": { + "description": "Gets all the phraselist features in a version of the application.", + "operationId": "Features_ListPhraseLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Phraselist Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/features": { + "get": { + "description": "Gets all the extraction phraselist and pattern features in a version of the application.", + "operationId": "Features_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features and a list of all pattern features.", + "schema": { + "$ref": "#/definitions/FeaturesResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { + "get": { + "description": "Gets phraselist feature info in a version of the application.", + "operationId": "Features_GetPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be retrieved.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "A phraselist feature info.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the phrases, the state and the name of the phraselist feature in a version of the application.", + "operationId": "Features_UpdatePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be updated.", + "required": true, + "type": "integer" + }, + { + "name": "phraselistUpdateObject", + "in": "body", + "schema": { + "$ref": "#/definitions/PhraselistUpdateObject" + }, + "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a phraselist feature from a version of the application.", + "operationId": "Features_DeletePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be deleted.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/example": { + "post": { + "description": "Adds a labeled example utterance in a version of the application.", + "operationId": "Examples_Add", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleLabelObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObject" + }, + "description": "A labeled example utterance with the expected intent and entities." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created example utterance.", + "schema": { + "$ref": "#/definitions/LabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Label request": { + "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples": { + "post": { + "description": "Adds a batch of labeled example utterances to a version of the application.", + "operationId": "Examples_Batch", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleLabelObjectArray", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObjectArray" + }, + "description": "Array of example utterances." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "A string array determining which labeled example utterances were added successfully.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "207": { + "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labeled example utterances.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Batch Add Labels request": { + "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "get": { + "description": "Returns example utterances to be reviewed from a version of the application.", + "operationId": "Examples_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of predictions and label pairs for every example utterance in the application.", + "schema": { + "$ref": "#/definitions/LabeledUtterances" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Review Labeled Examples request": { + "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { + "delete": { + "description": "Deletes the labeled example utterances with the specified ID from a version of the application.", + "operationId": "Examples_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleId", + "in": "path", + "description": "The example ID.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted example utterance.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Example Label request": { + "$ref": "./examples/examples/SuccessfulDeleteExampleLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents": { + "post": { + "description": "Adds an intent to a version of the application.", + "operationId": "Model_AddIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "intentCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCreateObject" + }, + "description": "A model object containing the name of the new intent." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created intent model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Intent Classifier request": { + "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" + } + } + }, + "get": { + "description": "Gets information about the intent models in a version of the application.", + "operationId": "Model_ListIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of intent model infos.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Intent Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities": { + "post": { + "description": "Adds an entity extractor to a version of the application.", + "operationId": "Model_AddEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityModelCreateObject" + }, + "description": "A model object containing the name of the new entity extractor and its children." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" + } + } + }, + "get": { + "description": "Gets information about all the simple entity models in a version of the application.", + "operationId": "Model_ListEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of entity model infos.", + "schema": { + "$ref": "#/definitions/NDepthEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities": { + "get": { + "description": "Gets information about all the hierarchical entity models in a version of the application.", + "operationId": "Model_ListHierarchicalEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of hierarchical entity model infos.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Hierarchical Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities": { + "get": { + "description": "Gets information about all the composite entity models in a version of the application.", + "operationId": "Model_ListCompositeEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of composite entity model infos.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Composite Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists": { + "get": { + "description": "Gets information about all the list entity models in a version of the application.", + "operationId": "Model_ListClosedLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of list entity model infos.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Closed List Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + } + } + }, + "post": { + "description": "Adds a list entity model to a version of the application.", + "operationId": "Model_AddClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "closedListModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelCreateObject" + }, + "description": "A model containing the name and words for the new list entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Closed List Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts": { + "post": { + "description": "Adds a list of prebuilt entities to a version of the application.", + "operationId": "Model_AddPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltExtractorNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltExtractorNames" + }, + "description": "An array of prebuilt entity extractor names." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created prebuilt extractor infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json" + } + } + }, + "get": { + "description": "Gets information about all the prebuilt entities in a version of the application.", + "operationId": "Model_ListPrebuilts", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of prebuilt entity models infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/listprebuilts": { + "get": { + "description": "Gets all the available prebuilt entities in a version of the application.", + "operationId": "Model_ListPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the possible prebuilt entity extractors.", + "schema": { + "$ref": "#/definitions/AvailablePrebuiltEntityModels" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Prebuilt Entity Extractors request": { + "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models": { + "get": { + "description": "Gets information about all the intent and entity models in a version of the application.", + "operationId": "Model_ListModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of application model infos.", + "schema": { + "$ref": "#/definitions/ModelsInfoResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Model Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models/{modelId}/examples": { + "get": { + "description": "Gets the example utterances for the given intent or entity model in a version of the application.", + "operationId": "Model_Examples", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "modelId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID (GUID) of the model.", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of example utterances for the model.", + "schema": { + "$ref": "#/definitions/ExamplesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Examples Per Model Request": { + "$ref": "./examples/model/SuccessfulGetExamplesPerModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}": { + "get": { + "description": "Gets information about the intent model in a version of the application.", + "operationId": "Model_GetIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], + "responses": { + "200": { + "description": "An intent model info.", + "schema": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intent Info request": { + "$ref": "./examples/model/SuccessfulGetIntentInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name of an intent in a version of the application.", + "operationId": "Model_UpdateIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "A model object containing the new intent name." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Intent Model request": { + "$ref": "./examples/model/SuccessfulRenameIntentModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes an intent from a version of the application.", + "operationId": "Model_DeleteIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "deleteUtterances", + "in": "query", + "type": "boolean", + "description": "If true, deletes the intent's example utterances. If false, moves the example utterances to the None intent. The default value is false.", + "default": false + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Intent Model request": { + "$ref": "./examples/model/SuccessfulDeleteIntentModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}": { + "get": { + "description": "Gets information about an entity model in a version of the application.", + "operationId": "Model_GetEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity model info.", + "schema": { + "$ref": "#/definitions/NDepthEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Info request": { + "$ref": "./examples/model/SuccessfulGetEntityInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes an entity or a child from a version of the application.", + "operationId": "Model_DeleteEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor or the child entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteEntityExtractorRequest.json" + } + } + }, + "patch": { + "description": "Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.", + "operationId": "Model_UpdateEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor or the child entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityModelUpdateObject" + }, + "description": "A model object containing the name new entity extractor or the name and instance of model of a child entity extractor " + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Entity Extractor request": { + "$ref": "./examples/model/SuccessfulUpdateEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/features": { + "post": { + "description": "Adds a new feature relation to be used by the intent in a version of the application.", + "operationId": "Features_AddIntentFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A Feature relation information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Feature Relation request": { + "$ref": "./examples/model/SuccessfulAddIntentFeatureRelationRequest.json" + } + } + }, + "get": { + "description": "Gets the information of the features used by the intent in a version of the application.", + "operationId": "Model_GetIntentFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of feature information objects for the intent.", + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Features information request": { + "$ref": "./examples/model/SuccessfulGetIntentFeaturesInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the information of the features used by the intent in a version of the application.", + "operationId": "Model_ReplaceIntentFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationsUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + }, + "description": "A list of feature information objects containing the new feature relations." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Replace Features request": { + "$ref": "./examples/model/SuccessfulReplaceIntentFeaturesRequest.json" + } + } + }, + "delete": { + "description": "Deletes a relation from the feature relations used by the intent in a version of the application.", + "operationId": "Model_DeleteIntentFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationDeleteObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A feature information object containing the feature relation to delete." + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete feature relation request": { + "$ref": "./examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/features": { + "post": { + "description": "Adds a new feature relation to be used by the entity in a version of the application.", + "operationId": "Features_AddEntityFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A Feature relation information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Feature Relation request": { + "$ref": "./examples/model/SuccessfulAddEntityFeatureRelationRequest.json" + } + } + }, + "get": { + "description": "Gets the information of the features used by the entity in a version of the application.", + "operationId": "Model_GetEntityFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of feature information objects for the entity.", + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Features information request": { + "$ref": "./examples/model/SuccessfulGetEntityFeaturesInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the information of the features used by the entity in a version of the application.", + "operationId": "Model_ReplaceEntityFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationsUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + }, + "description": "A list of feature information objects containing the new feature relations." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Replace Features request": { + "$ref": "./examples/model/SuccessfulReplaceEntityFeaturesRequest.json" + } + } + }, + "delete": { + "description": "Deletes a relation from the feature relations used by the entity in a version of the application.", + "operationId": "Model_DeleteEntityFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationDeleteObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A feature information object containing the feature relation to delete." + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete feature relation request": { + "$ref": "./examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { + "get": { + "description": "Gets information about a hierarchical entity in a version of the application.", + "operationId": "Model_GetHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A hierarchical entity model info.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json" + } + } + }, + "patch": { + "description": "Updates the name of a hierarchical entity model in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "Model containing names of the hierarchical entity." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity from a version of the application.", + "operationId": "Model_DeleteHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { + "get": { + "description": "Gets information about a composite entity in a version of the application.", + "operationId": "Model_GetCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "The composite entity model info.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Composite Entity Info request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates a composite entity in a version of the application.", + "operationId": "Model_UpdateCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompositeEntityModel" + }, + "description": "A model object containing the new entity extractor name and children." + } + ], + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Composite Entity Extractor request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityModelRequest.json" + } + }, + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a composite entity from a version of the application.", + "operationId": "Model_DeleteCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { + "get": { + "description": "Gets information about a list entity in a version of the application.", + "operationId": "Model_GetClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The list model info.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the list entity in a version of the application.", + "operationId": "Model_UpdateClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelUpdateObject" + }, + "description": "The new list entity name and words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated list entity name and words list.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityModelRequest.json" + } + } + }, + "patch": { + "description": "Adds a batch of sublists to an existing list entity in a version of the application.", + "operationId": "Model_PatchClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelPatchObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelPatchObject" + }, + "description": "A words list batch." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully added sublists to the list entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add SubLists to Closed List Entity request": { + "$ref": "./examples/model/SuccessfulPatchClosedListEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a list entity model from a version of the application.", + "operationId": "Model_DeleteClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully delete list entity from a version of application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + "get": { + "description": "Gets information about a prebuilt entity model in a version of the application.", + "operationId": "Model_GetPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A prebuilt entity models info.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a prebuilt entity extractor from a version of the application.", + "operationId": "Model_DeletePrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { + "delete": { + "description": "Deletes a sublist of a specific list entity model from a version of the application.", + "operationId": "Model_DeleteSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully deleted sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Sublist request": { + "$ref": "./examples/model/SuccessfulDeleteSublistRequest.json" + } + } + }, + "put": { + "description": "Updates one of the list entity's sublists in a version of the application.", + "operationId": "Model_UpdateSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "wordListBaseUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListBaseUpdateObject" + }, + "description": "A sublist update object containing the new canonical form and the list of words." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Sublist request": { + "$ref": "./examples/model/SuccessfulUpdateSublistRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { + "get": { + "description": "Suggests example utterances that would improve the accuracy of the intent model in a version of the application.", + "operationId": "Model_ListIntentSuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "If there's no trained intent model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the intent model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/IntentsSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intents Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetIntentsSuggestionExamples.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { + "get": { + "description": "Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.", + "operationId": "Model_ListEntitySuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The target entity extractor model to enhance.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "If there's no trained entity model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the entity model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/EntitiesSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetEntitySuggestionExamples.json" + } + } + } + }, + "/apps/": { + "post": { + "description": "Creates a new LUIS app.", + "operationId": "Apps_Add", + "parameters": [ + { + "name": "applicationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationCreateObject" + }, + "description": "An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is \"0.1\". Note: the culture cannot be changed after the app is created." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Application Creation": { + "$ref": "./examples/apps/SuccessfulAddApplicationRequest.json" + } + } + }, + "get": { + "description": "Lists all of the user's applications.", + "operationId": "Apps_List", + "parameters": [ + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of the user applications.", + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Applications List request": { + "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" + } + } + } + }, + "/apps/import": { + "post": { + "description": "Imports an application to LUIS, the application's structure is included in the request body.", + "operationId": "Apps_Import", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the imported application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/apps/SuccessfulImportApplicationRequest.json" + } + } + } + }, + "/apps/assistants": { + "get": { + "description": "Gets the endpoint URLs for the prebuilt Cortana applications.", + "operationId": "Apps_ListCortanaEndpoints", + "responses": { + "200": { + "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", + "schema": { + "$ref": "#/definitions/PersonalAssistantsResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Personal Assistant Applications": { + "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" + } + } + } + }, + "/apps/domains": { + "get": { + "description": "Gets the available application domains.", + "operationId": "Apps_ListDomains", + "responses": { + "200": { + "description": "A list object containing the available application domains.", + "schema": { + "$ref": "#/definitions/AvailableDomains" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Domains request": { + "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" + } + } + } + }, + "/apps/usagescenarios": { + "get": { + "description": "Gets the application available usage scenarios.", + "operationId": "Apps_ListUsageScenarios", + "responses": { + "200": { + "description": "A list object containing the available application usage scenarios.", + "schema": { + "$ref": "#/definitions/ApplicationUsageScenarios" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Usage Scenarios request": { + "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" + } + } + } + }, + "/apps/cultures": { + "get": { + "description": "Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,\"en-us\" represents the U.S. variation of English.", + "operationId": "Apps_ListSupportedCultures", + "responses": { + "200": { + "description": "A list object containing the supported application cultures.", + "schema": { + "$ref": "#/definitions/AvailableCultures" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Cultures request": { + "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" + } + } + } + }, + "/apps/{appId}/querylogs": { + "get": { + "description": "Gets the logs of the past month's endpoint queries for the application.", + "operationId": "Apps_DownloadQueryLogs", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "A CSV file containing the query logs for the past month.", + "schema": { + "type": "object", + "format": "file", + "description": "The query logs of an application for the past month in CSV format." + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream" + ], + "x-ms-examples": { + "Successful Download Application Query logs request": { + "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" + } + } + } + }, + "/apps/{appId}": { + "get": { + "description": "Gets the application info.", + "operationId": "Apps_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application info.", + "schema": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Info request": { + "$ref": "./examples/apps/SuccessfulGetApplicationInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application.", + "operationId": "Apps_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application name and description.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulRenameApplicationRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application.", + "operationId": "Apps_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/ForcePath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulDeleteApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/clone": { + "post": { + "description": "Creates a new version from the selected version.", + "operationId": "Versions_Clone", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionCloneObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing the new version ID." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The new version ID.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Clone Application Version request": { + "$ref": "./examples/versions/SuccessfulCloneApplicatioVersionRequest.json" + } + } + } + }, + "/apps/{appId}/publish": { + "post": { + "description": "Publishes a specific version of the application.", + "operationId": "Apps_Publish", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationPublishObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationPublishObject" + }, + "description": "The application publish object. The region is the target region that the application is published to." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "207": { + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status in case that publishing one or more regions failed.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Publish Application request": { + "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions": { + "get": { + "description": "Gets a list of versions for this application ID.", + "operationId": "Versions_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all versions of the application.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VersionInfo" + } + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Versions info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/": { + "get": { + "description": "Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.", + "operationId": "Versions_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A model containing the version info.", + "schema": { + "$ref": "#/definitions/VersionInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application version.", + "operationId": "Versions_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application Version request": { + "$ref": "./examples/versions/SuccessfulRenameApplicationVersionRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application version.", + "operationId": "Versions_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Application Version request": { + "$ref": "./examples/versions/SuccessfulDeleteApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/export": { + "get": { + "description": "Exports a LUIS application to JSON format.", + "operationId": "Versions_Export", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "The LUIS application structure in JSON format." + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Export Application Version": { + "$ref": "./examples/versions/SuccessfulExportApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/train": { + "post": { + "description": "Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.", + "operationId": "Train_TrainVersion", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "202": { + "description": "This response indicates the initial training status.", + "schema": { + "$ref": "#/definitions/EnqueueTrainingResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Train Application Version request": { + "$ref": "./examples/train/SuccessfulTrainApplicationVersionRequest.json" + } + } + }, + "get": { + "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".", + "operationId": "Train_GetStatus", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v3.0-preview/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled example utterances were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".", + "schema": { + "$ref": "#/definitions/ModelTrainingInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json", + "JSON" + ], + "x-ms-examples": { + "Successful Get Application Version Training Status request": { + "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" + } + } + } + }, + "/apps/{appId}/versions/import": { + "post": { + "description": "Imports a new version into a LUIS application.", + "operationId": "Versions_Import", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "versionId", + "in": "query", + "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The created application version.", + "schema": { + "$ref": "#/definitions/VersionResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/versions/SuccessfulImportApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/settings": { + "get": { + "description": "Get the application settings including 'UseAllTrainingData'.", + "operationId": "Apps_GetSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application settings.", + "schema": { + "$ref": "#/definitions/ApplicationSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Settings request": { + "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application settings including 'UseAllTrainingData'.", + "operationId": "Apps_UpdateSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSettingUpdateObject" + }, + "description": "An object containing the new application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Application Settings request": { + "$ref": "./examples/apps/SuccessfulUpdateApplicationSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/publishsettings": { + "get": { + "description": "Get the application publish settings including 'UseAllTrainingData'.", + "operationId": "Apps_GetPublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application publish settings.", + "schema": { + "$ref": "#/definitions/PublishSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Publish Settings request": { + "$ref": "./examples/apps/SuccessfulGetPublishSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application publish settings including 'UseAllTrainingData'.", + "operationId": "Apps_UpdatePublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "publishSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublishSettingUpdateObject" + }, + "description": "An object containing the new publish application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Publish Settings request": { + "$ref": "./examples/apps/SuccessfulUpdatePublishSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/suggest": { + "delete": { + "description": "Deleted an unlabelled utterance in a version of the application.", + "operationId": "Versions_DeleteUnlabelledUtterance", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "utterance", + "in": "body", + "required": true, + "schema": { + "type": "string" + }, + "description": "The utterance text to delete." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Unlabelled Utterance": { + "$ref": "./examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json" + } + } + } + }, + "/apps/{appId}/permissions": { + "get": { + "description": "Gets the list of user emails that have permissions to access your application.", + "operationId": "Permissions_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The list includes a single owner. All collaborators are listed in the emails array.", + "schema": { + "$ref": "#/definitions/UserAccessList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application User Access List": { + "$ref": "./examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json" + } + } + }, + "post": { + "description": "Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.", + "operationId": "Permissions_Add", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "userToAdd", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserCollaborator" + }, + "description": "A model containing the user's email address." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add User To Access List": { + "$ref": "./examples/permissions/SuccessfulAddUserToAccessListRequest.json" + } + } + }, + "delete": { + "description": "Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.", + "operationId": "Permissions_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "userToDelete", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserCollaborator" + }, + "description": "A model containing the user's email address." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Remove User From Access List": { + "$ref": "./examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json" + } + } + }, + "put": { + "description": "Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.", + "operationId": "Permissions_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "collaborators", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CollaboratorsArray" + }, + "description": "A model containing a list of user email addresses." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Replaces Users From Access List": { + "$ref": "./examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json" + } + } + } + }, + "/apps/{appId}/endpoints": { + "get": { + "description": "Returns the available endpoint deployment regions and URLs.", + "operationId": "Apps_ListEndpoints", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of endpoints regions and their corresponding endpoint URL.", + "schema": { + "$ref": "#/definitions/AvailableEndpoints" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Endpoints request": { + "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { + "post": { + "description": "Adds a sublist to an existing list entity in a version of the application.", + "operationId": "Model_AddSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "wordListCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListObject" + }, + "description": "Words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the newly created sublist.", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Sublist request": { + "$ref": "./examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { + "post": { + "description": "Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.", + "operationId": "Model_AddCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateBaseObject" + }, + "description": "A prebuilt domain create object containing the name of the domain." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created customizable prebuilt domain intent and entity model Ids.", + "schema": { + "$ref": "#/definitions/GuidList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Domain to Application request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltintents": { + "post": { + "description": "Adds a customizable prebuilt intent model to a version of the application.", + "operationId": "Model_AddCustomPrebuiltIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created intent model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildIntentRequest.json" + } + } + }, + "get": { + "description": "Gets information about customizable prebuilt intents added to a version of the application.", + "operationId": "Model_ListCustomPrebuiltIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all customizable prebuilt intents and their representations in a version of the application.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuildIntentRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities": { + "post": { + "description": "Adds a prebuilt entity model to a version of the application.", + "operationId": "Model_AddCustomPrebuiltEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created prebuilt model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Entity request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json" + } + } + }, + "get": { + "description": "Gets all prebuilt entities used in a version of the application.", + "operationId": "Model_ListCustomPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all prebuilt entities and their representations.", + "schema": { + "$ref": "#/definitions/EntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entities request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { + "get": { + "description": "Gets all prebuilt intent and entity model information used in a version of this application.", + "operationId": "Model_ListCustomPrebuiltModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all prebuilt models and their representations.", + "schema": { + "$ref": "#/definitions/CustomPrebuiltModelList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Models request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { + "delete": { + "description": "Deletes a prebuilt domain's models in a version of the application.", + "operationId": "Model_DeleteCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "domainName", + "in": "path", + "description": "Domain name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Prebuilt Domain from Application request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains": { + "get": { + "description": "Gets all the available custom prebuilt domains for all cultures.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomains", + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt domains and their intents/entities representation.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Custom Prebuilt Domains request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json" + } + } + }, + "post": { + "description": "Adds a prebuilt domain along with its intent and entity models as a new application.", + "operationId": "Apps_AddCustomPrebuiltDomain", + "parameters": [ + { + "name": "prebuiltDomainCreateObject", + "in": "body", + "required": true, + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateObject" + } + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Application request": { + "$ref": "./examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains/{culture}": { + "get": { + "description": "Gets all the available prebuilt domains for a specific culture.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture", + "parameters": [ + { + "name": "culture", + "in": "path", + "description": "Culture.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns a list of all domains and their intents and entities for a specific culture.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/children": { + "post": { + "description": "Creates a single child in an existing entity model hierarchy in a version of the application.", + "operationId": "Model_AddEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "childEntityModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "description": "A model object containing the name of the new child model and its children." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateEntityChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { + "get": { + "description": "Gets information about the child's model contained in an hierarchical entity child model in a version of the application.", + "operationId": "Model_GetHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The hierarchical entity child model info.", + "schema": { + "$ref": "#/definitions/HierarchicalChildEntity" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Child Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json" + } + } + }, + "patch": { + "description": "Renames a single child in an existing hierarchical entity model in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "required": true, + "description": "The hierarchical entity extractor child ID.", + "type": "string", + "format": "uuid" + }, + { + "name": "hierarchicalChildModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "Model object containing new name of the hierarchical entity child." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated entity child.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity extractor child in a version of the application.", + "operationId": "Model_DeleteHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { + "post": { + "description": "Creates a single child in an existing composite entity model in a version of the application.", + "operationId": "Model_AddCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeChildModelCreateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "A model object containing the name of the new composite child model." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { + "delete": { + "description": "Deletes a composite entity extractor child from a version of the application.", + "operationId": "Model_DeleteCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "cChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities": { + "get": { + "summary": "Gets information about the regular expression entity models in a version of the application.", + "operationId": "Model_ListRegexEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of regular expression entity model infos.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Models request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a regular expression entity model to a version of the application.", + "operationId": "Model_CreateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityExtractorCreateObj", + "in": "body", + "description": "A model object containing the name and regex pattern for the new regular expression entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities": { + "get": { + "summary": "Get information about the Pattern.Any entity models in a version of the application.", + "operationId": "Model_ListPatternAnyEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of Pattern.Any entity model infos.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a pattern.any entity extractor to a version of the application.", + "operationId": "Model_CreatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "extractorCreateObject", + "in": "body", + "description": "A model object containing the name and explicit list for the new Pattern.Any entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created Pattern.Any entity model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles": { + "get": { + "summary": "Get all roles for an entity in a version of the application", + "operationId": "Model_ListEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role in a version of the application.", + "operationId": "Model_CreateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles": { + "get": { + "summary": "Get a prebuilt entity's roles in a version of the application.", + "operationId": "Model_ListPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a prebuilt entity in a version of the application.", + "operationId": "Model_CreatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles": { + "get": { + "summary": "Get all roles for a list entity in a version of the application.", + "operationId": "Model_ListClosedListEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a list entity in a version of the application.", + "operationId": "Model_CreateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a regular expression entity in a version of the application.", + "operationId": "Model_ListRegexEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an regular expression entity in a version of the application.", + "operationId": "Model_CreateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles": { + "get": { + "summary": "Get all roles for a composite entity in a version of the application", + "operationId": "Model_ListCompositeEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a composite entity in a version of the application.", + "operationId": "Model_CreateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a Pattern.any entity in a version of the application", + "operationId": "Model_ListPatternAnyEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an Pattern.any entity in a version of the application.", + "operationId": "Model_CreatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles": { + "get": { + "summary": "Get all roles for a hierarchical entity in a version of the application", + "operationId": "Model_ListHierarchicalEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an hierarchical entity in a version of the application.", + "operationId": "Model_CreateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a prebuilt entity in a version of the application", + "operationId": "Model_ListCustomPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a prebuilt entity in a version of the application.", + "operationId": "Model_CreateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist": { + "get": { + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", + "operationId": "Model_GetExplicitList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the explicit list items", + "schema": { + "$ref": "#/definitions/ExplicitListItemList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Explicit List request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListRequest.json" + } + } + }, + "post": { + "summary": "Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.", + "operationId": "Model_AddExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created explicit list item.", + "schema": { + "$ref": "#/definitions/ExplicitListItemIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}": { + "get": { + "summary": "Gets information about a regular expression entity in a version of the application.", + "operationId": "Model_GetRegexEntityEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regular expression entity model info.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the regular expression entity in a version of the application.", + "operationId": "Model_UpdateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "regexEntityUpdateObject", + "in": "body", + "description": "An object containing the new entity name and regex pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the regular expression entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityModelRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a regular expression entity from a version of the application.", + "operationId": "Model_DeleteRegexEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}": { + "get": { + "summary": "Gets information about the Pattern.Any model in a version of the application.", + "operationId": "Model_GetPatternAnyEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regular expression entity model info.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.", + "operationId": "Model_UpdatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "patternAnyUpdateObject", + "in": "body", + "description": "An object containing the explicit list of the Pattern.Any entity.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Pattern.Any entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a Pattern.Any entity extractor from a version of the application.", + "operationId": "Model_DeletePatternAnyEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given entity in a version of the application", + "operationId": "Model_GetEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulGetEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given entity in a version of the application.", + "operationId": "Model_UpdateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role in a version of the application.", + "operationId": "Model_DeleteEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulDeleteEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given prebuilt entity in a version of the application", + "operationId": "Model_GetPrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given prebuilt entity in a version of the application", + "operationId": "Model_UpdatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role in a prebuilt entity in a version of the application.", + "operationId": "Model_DeletePrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given list entity in a version of the application.", + "operationId": "Model_GetClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given list entity in a version of the application.", + "operationId": "Model_UpdateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Closed List Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given list entity in a version of the application.", + "operationId": "Model_DeleteClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given regular expression entity in a version of the application.", + "operationId": "Model_GetRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given regular expression entity in a version of the application", + "operationId": "Model_UpdateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given regular expression in a version of the application.", + "operationId": "Model_DeleteRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given composite entity in a version of the application", + "operationId": "Model_GetCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given composite entity in a version of the application", + "operationId": "Model_UpdateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Composite Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given composite entity in a version of the application.", + "operationId": "Model_DeleteCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_GetPatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_UpdatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_DeletePatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given hierarchical entity in a version of the application.", + "operationId": "Model_GetHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given hierarchical entity in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Hierarchical Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given hierarchical role in a version of the application.", + "operationId": "Model_DeleteHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given prebuilt entity in a version of the application.", + "operationId": "Model_GetCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given prebuilt entity in a version of the application.", + "operationId": "Model_UpdateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Custom Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given prebuilt entity in a version of the application.", + "operationId": "Model_DeleteCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}": { + "get": { + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", + "operationId": "Model_GetExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item Id.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "An explicit list item info.", + "schema": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json" + } + } + }, + "put": { + "summary": "Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.", + "operationId": "Model_UpdateExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item ID.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the explicit list item.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Explicit List Item request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json" + } + } + }, + "delete": { + "summary": "Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.", + "operationId": "Model_DeleteExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The pattern.any entity id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item which will be deleted.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrule": { + "post": { + "summary": "Adds a pattern to a version of the application.", + "operationId": "Pattern_AddPattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "pattern", + "in": "body", + "description": "The input pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The created pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Add Pattern request": { + "$ref": "./examples/patterns/SuccessfulAddPatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules": { + "get": { + "summary": "Gets patterns in a version of the application.", + "operationId": "Pattern_ListPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Application Version Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetPatternsRequest.json" + } + } + }, + "put": { + "summary": "Updates patterns in a version of the application.", + "operationId": "Pattern_UpdatePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "An array represents the patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + } + ], + "responses": { + "200": { + "description": "The updated patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Update Patterns request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternsRequest.json" + } + } + }, + "post": { + "summary": "Adds a batch of patterns in a version of the application.", + "operationId": "Pattern_BatchAddPatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "A JSON array containing patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + } + ], + "responses": { + "201": { + "description": "The created patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Add Patterns request": { + "$ref": "./examples/patterns/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a list of patterns in a version of the application.", + "operationId": "Pattern_DeletePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternIds", + "in": "body", + "description": "The patterns IDs.", + "required": true, + "schema": { + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Delete Patterns request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules/{patternId}": { + "put": { + "summary": "Updates a pattern in a version of the application.", + "operationId": "Pattern_UpdatePattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "pattern", + "in": "body", + "description": "An object representing a pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "The updated pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternRequest.json" + } + } + }, + "delete": { + "summary": "Deletes the pattern with the specified ID from a version of the application..", + "operationId": "Pattern_DeletePattern", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules": { + "get": { + "summary": "Returns patterns for the specific intent in a version of the application.", + "operationId": "Pattern_ListIntentPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Intent Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetIntentPatternsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/settings": { + "get": { + "description": "Gets the settings in a version of the application.", + "operationId": "Settings_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the application version settings.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AppVersionSettingObject" + } + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version settings request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the settings in a version of the application.", + "operationId": "Settings_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "listOfAppVersionSettingObject", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AppVersionSettingObject" + } + }, + "description": "A list of the updated application version settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Application Version settings request": { + "$ref": "./examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/azureaccounts": { + "post": { + "description": "Assigns an Azure account to the application.", + "operationId": "AzureAccounts_AssignToApp", + "summary": "apps - Assign a LUIS Azure account to an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The Azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Assign azure account request": { + "$ref": "./examples/stats/SuccessfulAssignAzureAccountRequest.json" + } + } + }, + "get": { + "description": "Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.", + "operationId": "AzureAccounts_GetAssigned", + "summary": "apps - Get LUIS Azure accounts assigned to the application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + } + ], + "responses": { + "200": { + "description": "A list of azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get assigned azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json" + } + } + }, + "delete": { + "description": "Removes assigned Azure account from the application.", + "operationId": "AzureAccounts_RemoveFromApp", + "summary": "apps - Removes an assigned LUIS Azure account from an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The Azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful delete assigned azure account request": { + "$ref": "./examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json" + } + } + } + }, + "/azureaccounts": { + "get": { + "description": "Gets the LUIS Azure accounts for the user using his ARM token.", + "operationId": "AzureAccounts_ListUserLUISAccounts", + "summary": "user - Get LUIS Azure accounts", + "parameters": [ + { + "$ref": "#/parameters/BearerAuthPath" + } + ], + "responses": { + "200": { + "description": "A list of Azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAzureAccountsRequest.json" + } + } + } + }, + "/package/{appId}/slot/{slotName}/gzip": { + "get": { + "description": "Packages a published LUIS application as a GZip file to be used in the LUIS container.", + "operationId": "Apps_PackagePublishedApplicationAsGzip", + "summary": "package - Gets published LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SlotNameInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the published application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetTrainedApplicationPackageRequest.json" + } + } + } + }, + "/package/{appId}/versions/{versionId}/gzip": { + "get": { + "description": "Packages trained LUIS application as GZip file to be used in the LUIS container.", + "operationId": "Apps_PackageTrainedApplicationAsGzip", + "summary": "package - Gets trained LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the trained application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetPublishedApplicationPackageRequest.json" + } + } + } + } + }, + "definitions": { + "EntityLabelObject": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "required": [ + "entityName", + "startCharIndex", + "endCharIndex" + ], + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startCharIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endCharIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "role": { + "description": "The role the entity plays in the utterance.", + "type": "string" + } + } + }, + "ApplicationCreateObject": { + "description": "Properties for creating a new LUIS Application", + "type": "object", + "required": [ + "culture", + "name" + ], + "properties": { + "culture": { + "description": "The culture for the new application. It is the language that your app understands and speaks. E.g.: \"en-us\". Note: the culture cannot be changed after the app is created.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. E.g.: Comics.", + "type": "string" + }, + "description": { + "description": "Description of the new application. Optional.", + "type": "string" + }, + "initialVersionId": { + "description": "The initial version ID. Optional. Default value is: \"0.1\"", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", + "type": "string" + }, + "name": { + "description": "The name for the new application.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateBaseObject": { + "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateObject": { + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "culture": { + "description": "The culture of the new domain.", + "type": "string" + } + } + }, + "PrebuiltDomainModelCreateObject": { + "description": "A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "modelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "CompositeEntityModel": { + "description": "A composite entity extractor.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "EntityModelCreateObject": { + "description": "An entity extractor create object.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "ChildEntityModelCreateObject": { + "description": "A child entity extractor create object.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + }, + "instanceOf": { + "description": "The instance of model name", + "type": "string" + } + } + }, + "EntityModelUpdateObject": { + "description": "An entity extractor update object.", + "type": "object", + "properties": { + "name": { + "description": "Entity name.", + "type": "string" + }, + "instanceOf": { + "description": "The instance of model name", + "type": "string" + } + } + }, + "JSONEntity": { + "description": "Exported Model - Extracted Entity from utterance.", + "type": "object", + "required": [ + "startPos", + "endPos", + "entity" + ], + "properties": { + "startPos": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endPos": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "entity": { + "description": "The entity name.", + "type": "string" + }, + "role": { + "description": "The role the entity plays in the utterance.", + "type": "string" + } + } + }, + "ApplicationSettingUpdateObject": { + "description": "Object model for updating an application's settings.", + "type": "object", + "properties": { + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "isPublic" + } + } + }, + "PublishSettingUpdateObject": { + "description": "Object model for updating an application's publish settings.", + "type": "object", + "properties": { + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response", + "type": "boolean", + "x-nullable": false + }, + "speech": { + "description": "Setting speech as public enables speech priming in your app", + "type": "boolean", + "x-nullable": false + }, + "spellChecker": { + "description": "Setting spell checker as public enables spell checking the input utterance.", + "type": "boolean", + "x-nullable": false + } + } + }, + "ExampleLabelObject": { + "description": "A labeled example utterance.", + "type": "object", + "properties": { + "text": { + "description": "The example utterance.", + "type": "string" + }, + "entityLabels": { + "description": "The identified entities within the example utterance.", + "items": { + "type": "object", + "$ref": "#/definitions/EntityLabelObject" + }, + "type": "array" + }, + "intentName": { + "description": "The identified intent representing the example utterance.", + "type": "string" + } + } + }, + "PhraselistCreateObject": { + "description": "Object model for creating a phraselist model.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isExchangeable": { + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", + "default": true, + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "SubClosedList": { + "description": "Sublist of items for a list entity.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "SubClosedListResponse": { + "description": "Sublist of items for a list entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubClosedList" + } + ], + "properties": { + "id": { + "description": "The sublist ID", + "type": "integer", + "x-nullable": false + } + } + }, + "ApplicationUpdateObject": { + "description": "Object model for updating the name or description of an application.", + "type": "object", + "properties": { + "name": { + "description": "The application's new name.", + "type": "string" + }, + "description": { + "description": "The application's new description.", + "type": "string" + } + } + }, + "PrebuiltExtractorNames": { + "description": "Object model for adding a prebuilt entity to the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "JSONRegexFeature": { + "description": "Exported Model - A Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + }, + "activated": { + "description": "Indicates if the Pattern feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + } + } + }, + "ClosedList": { + "description": "Exported Model - A list entity.", + "type": "object", + "properties": { + "name": { + "description": "Name of the list entity.", + "type": "string" + }, + "subLists": { + "description": "Sublists for the list entity.", + "items": { + "type": "object", + "$ref": "#/definitions/SubClosedList" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "ClosedListModelPatchObject": { + "description": "Object model for adding a batch of sublists to an existing list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists to add.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + } + } + }, + "JSONModelFeature": { + "description": "Exported Model - Phraselist Model Feature.", + "type": "object", + "properties": { + "activated": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "words": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "mode": { + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "ModelCreateObject": { + "description": "Object model for creating a new entity extractor.", + "type": "object", + "properties": { + "name": { + "description": "Name of the new entity extractor.", + "type": "string" + } + } + }, + "WordListObject": { + "description": "Sublist of items for a list entity.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "WordListBaseUpdateObject": { + "description": "Object model for updating one of the list entity's sublists.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "JSONUtterance": { + "description": "Exported Model - Utterance that was used to train the model.", + "type": "object", + "properties": { + "text": { + "description": "The utterance.", + "type": "string" + }, + "intent": { + "description": "The matched intent.", + "type": "string" + }, + "entities": { + "description": "The matched entities.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONEntity" + }, + "type": "array" + } + } + }, + "ModelUpdateObject": { + "description": "Object model for updating an intent classifier.", + "type": "object", + "properties": { + "name": { + "description": "The entity's new name.", + "type": "string" + } + } + }, + "ClosedListModelUpdateObject": { + "description": "Object model for updating a list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "The new sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "The new name of the list entity.", + "type": "string" + } + } + }, + "ClosedListModelCreateObject": { + "description": "Object model for creating a list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "Name of the list entity.", + "type": "string" + } + } + }, + "ExampleLabelObjectArray": { + "description": "Object model for adding a batch of labeled examples.", + "items": { + "type": "object", + "$ref": "#/definitions/ExampleLabelObject" + }, + "type": "array" + }, + "VersionInfo": { + "description": "Object model of an application version.", + "type": "object", + "required": [ + "version", + "trainingStatus" + ], + "properties": { + "version": { + "description": "The version ID. E.g.: \"0.1\"", + "type": "string" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string", + "format": "date-time" + }, + "lastModifiedDateTime": { + "description": "Timestamp of the last update.", + "type": "string", + "format": "date-time" + }, + "lastTrainedDateTime": { + "description": "Timestamp of the last time the model was trained.", + "type": "string", + "format": "date-time" + }, + "lastPublishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string", + "format": "date-time" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "externalApiKeys": { + "description": "External keys.", + "type": "object" + }, + "intentsCount": { + "description": "Number of intents in this model.", + "type": "integer" + }, + "entitiesCount": { + "description": "Number of entities in this model.", + "type": "integer" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "trainingStatus": { + "description": "The current training status.", + "type": "string", + "enum": [ + "NeedsTraining", + "InProgress", + "Trained" + ], + "x-ms-enum": { + "name": "TrainingStatus" + } + } + } + }, + "TaskUpdateObject": { + "description": "Object model for cloning an application's version.", + "type": "object", + "properties": { + "version": { + "description": "The new version for the cloned model.", + "type": "string" + } + } + }, + "PhraselistUpdateObject": { + "description": "Object model for updating a Phraselist.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isActive": { + "description": "Indicates if the Phraselist is enabled.", + "default": true, + "type": "boolean" + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "default": true, + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "PrebuiltDomainObject": { + "type": "object", + "properties": { + "domain_name": { + "type": "string" + }, + "model_name": { + "type": "string" + } + } + }, + "JsonChild": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "instanceOf": { + "type": "string" + }, + "children": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonChild" + }, + "type": "array" + }, + "features": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonModelFeatureInformation" + }, + "type": "array" + } + } + }, + "HierarchicalModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "children": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonChild" + }, + "type": "array" + }, + "features": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonModelFeatureInformation" + }, + "type": "array" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "inherits": { + "type": "object", + "$ref": "#/definitions/PrebuiltDomainObject" + } + } + }, + "ApplicationPublishObject": { + "description": "Object model for publishing a specific application version.", + "type": "object", + "properties": { + "versionId": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "default": false, + "type": "boolean" + } + } + }, + "LuisApp": { + "description": "Exported Model - An exported LUIS Application.", + "additionalProperties": true, + "type": "object", + "properties": { + "name": { + "description": "The name of the application.", + "type": "string" + }, + "versionId": { + "description": "The version ID of the application that was exported.", + "type": "string" + }, + "desc": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. E.g.: en-us.", + "type": "string" + }, + "intents": { + "description": "List of intents.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "entities": { + "description": "List of entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "closedLists": { + "description": "List of list entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ClosedList" + }, + "type": "array" + }, + "composites": { + "description": "List of composite entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "hierarchicals": { + "description": "List of hierarchical entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "patternAnyEntities": { + "description": "List of Pattern.Any entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternAny" + }, + "type": "array" + }, + "regex_entities": { + "description": "List of regular expression entities.", + "items": { + "type": "object", + "$ref": "#/definitions/RegexEntity" + }, + "type": "array" + }, + "prebuiltEntities": { + "description": "List of prebuilt entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PrebuiltEntity" + }, + "type": "array" + }, + "regex_features": { + "description": "List of pattern features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONRegexFeature" + }, + "type": "array" + }, + "phraselists": { + "description": "List of model features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONModelFeature" + }, + "type": "array" + }, + "patterns": { + "description": "List of patterns.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternRule" + }, + "type": "array" + }, + "utterances": { + "description": "List of example utterances.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONUtterance" + }, + "type": "array" + } + } + }, + "GuidResponse": { + "description": "The ID (GUID) returned by an operation.", + "type": "string", + "format": "uuid" + }, + "VersionResponse": { + "description": "The new version ID returned by when importing a model version.", + "type": "string" + }, + "FeatureIDResponse": { + "description": "The ID of the created feature.", + "type": "integer", + "x-nullable": false + }, + "LabeledUtterances": { + "description": "A list of predictions and label pairs for every example in the application.", + "type": "array", + "items": { + "$ref": "#/definitions/LabeledUtterance" + } + }, + "LabeledUtterance": { + "description": "A prediction and label pair of an example.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of Labeled Utterance." + }, + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentLabel": { + "description": "The intent matching the example.", + "type": "string" + }, + "entityLabels": { + "description": "The entities matching the example.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityLabel" + } + }, + "intentPredictions": { + "description": "List of suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "List of suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "IntentsSuggestionExamples": { + "description": "List of predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentsSuggestionExample" + } + }, + "IntentsSuggestionExample": { + "description": "Predicted/suggested intent.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The tokenized utterance.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntitiesSuggestionExamples": { + "description": "List of predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesSuggestionExample" + } + }, + "EntitiesSuggestionExample": { + "description": "Predicted/suggested entity.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntityLabel": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "role": { + "type": "string", + "description": "The role of the predicted entity." + }, + "roleId": { + "type": "string", + "format": "uuid", + "description": "The role id for the predicted entity." + } + }, + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex" + ] + }, + "IntentPrediction": { + "description": "A suggested intent.", + "type": "object", + "properties": { + "name": { + "description": "The intent's name", + "type": "string" + }, + "score": { + "description": "The intent's score, based on the prediction model.", + "type": "number" + } + } + }, + "EntityPrediction": { + "description": "A suggested entity.", + "type": "object", + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex", + "phrase" + ], + "properties": { + "entityName": { + "description": "The entity's name", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "phrase": { + "type": "string", + "description": "The actual token(s) that comprise the entity." + } + } + }, + "PersonalAssistantsResponse": { + "type": "object", + "description": "Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.", + "properties": { + "endpointKeys": { + "$ref": "#/definitions/EndpointKeys" + }, + "endpointUrls": { + "$ref": "#/definitions/PersonalAssistantUrls" + } + } + }, + "EndpointKeys": { + "type": "array", + "description": "An a array of GUIDs, comprised of Azure Endpoint Keys and the Authoring API key.", + "items": { + "type": "string", + "format": "uuid" + } + }, + "PersonalAssistantUrls": { + "type": "object", + "description": "Endpoint URLs for prebuilt Cortana applications.", + "additionalProperties": { + "type": "string" + } + }, + "ModelInfo": { + "description": "Base type used in entity types.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "id", + "readableType" + ] + }, + "ModelsInfoResponseObject": { + "description": "A list of application model infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfoResponse" + } + }, + "ModelInfoResponse": { + "description": "An application model info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "id", + "readableType" + ], + "allOf": [ + { + "$ref": "#/definitions/HierarchicalEntityExtractor" + }, + { + "$ref": "#/definitions/CompositeEntityExtractor" + }, + { + "$ref": "#/definitions/ClosedListEntityExtractor" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + }, + { + "$ref": "#/definitions/RegexEntityExtractor" + }, + { + "$ref": "#/definitions/PatternAnyEntityExtractor" + }, + { + "$ref": "#/definitions/NDepthEntityExtractor" + } + ] + }, + "EntityModelInfo": { + "description": "An Entity Extractor model info.", + "type": "object", + "properties": { + "roles": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "ReadableType": { + "description": "Full name of the entity type.", + "type": "string", + "enum": [ + "Entity Extractor", + "Child Entity Extractor", + "Hierarchical Entity Extractor", + "Hierarchical Child Entity Extractor", + "Composite Entity Extractor", + "List Entity Extractor", + "Prebuilt Entity Extractor", + "Intent Classifier", + "Pattern.Any Entity Extractor", + "Closed List Entity Extractor", + "Regex Entity Extractor" + ] + }, + "HierarchicalEntityExtractor": { + "description": "Hierarchical Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Hierarchical Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "HierarchicalEntityExtractorsList": { + "description": "List of Hierarchical Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "CompositeEntityExtractor": { + "description": "A Composite Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Composite Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "CompositeEntityExtractorsList": { + "description": "List of Composite Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "ClosedListEntityExtractor": { + "description": "List Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "List Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "subLists": { + "description": "List of sublists.", + "type": "array", + "items": { + "$ref": "#/definitions/SubClosedListResponse" + } + } + } + }, + "ClosedListEntityExtractorsList": { + "description": "List of List Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "PrebuiltEntityExtractor": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Prebuilt Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ] + }, + "PrebuiltEntityExtractorsList": { + "description": "List of Prebuilt Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "ChildEntity": { + "type": "object", + "description": "The base child entity type.", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) belonging to a child entity." + }, + "name": { + "type": "string", + "description": "The name of a child entity." + }, + "instanceOf": { + "description": "Instance of Model.", + "type": "string" + }, + "typeId": { + "description": "The type ID of the Entity Model.", + "type": "integer" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + }, + "children": { + "description": "List of children", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + }, + "required": [ + "id" + ] + }, + "HierarchicalChildEntity": { + "description": "A Hierarchical Child Entity.", + "type": "object", + "properties": { + "typeId": { + "description": "The type ID of the Entity Model.", + "type": "integer" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ChildEntity" + } + ] + }, + "CustomPrebuiltModel": { + "description": "A Custom Prebuilt model.", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + } + ] + }, + "CustomPrebuiltModelList": { + "description": "A List of Custom Prebuilt models.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPrebuiltModel" + } + }, + "IntentClassifier": { + "description": "Intent Classifier.", + "type": "object", + "x-ms-discriminator-value": "Intent Classifier", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "EntityExtractor": { + "description": "Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "NDepthEntityExtractor": { + "description": "N-Depth Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "N-Depth Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "IntentClassifiersList": { + "description": "List of Intent Classifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "EntityExtractorsList": { + "description": "List of Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "NDepthEntityExtractorsList": { + "description": "List of N-Depth Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/NDepthEntityExtractor" + } + }, + "FeaturesResponseObject": { + "description": "Model Features, including Patterns and Phraselists.", + "type": "object", + "properties": { + "phraselistFeatures": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + }, + "patternFeatures": { + "$ref": "#/definitions/PatternFeatureInfoList" + } + } + }, + "FeatureInfoObject": { + "description": "The base class Features-related response objects inherit from.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A six-digit ID used for Features." + }, + "name": { + "type": "string", + "description": "The name of the Feature." + }, + "isActive": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the feature is enabled for all models in the application.", + "type": "boolean" + } + } + }, + "PatternFeatureInfo": { + "description": "Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PatternFeatureInfoList": { + "description": "List of Pattern features.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "PhraseListFeatureInfo": { + "description": "Phraselist Feature.", + "type": "object", + "properties": { + "phrases": { + "type": "string", + "description": "A list of comma-separated values." + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "type": "boolean" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PhraseListFeatureInfoList": { + "description": "List of Phraselist Features.", + "type": "array", + "items": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "LabelExampleResponse": { + "description": "Response when adding a labeled example utterance.", + "type": "object", + "properties": { + "UtteranceText": { + "description": "The example utterance.", + "type": "string" + }, + "ExampleId": { + "description": "The newly created sample ID.", + "type": "integer" + } + } + }, + "BatchLabelExample": { + "description": "Response when adding a batch of labeled example utterances.", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/LabelExampleResponse" + }, + "hasError": { + "type": "boolean" + }, + "error": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "BatchLabelExampleResponse": { + "description": "Response when adding a batch of labeled example utterances.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchLabelExample" + } + }, + "ApplicationInfoResponse": { + "description": "Response containing the Application Info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the application." + }, + "name": { + "description": "The name of the application.", + "type": "string" + }, + "description": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. For example, \"en-us\".", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. For example, IoT.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. For example, Comics.", + "type": "string" + }, + "versionsCount": { + "description": "Amount of model versions within the application.", + "type": "integer" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string" + }, + "endpoints": { + "description": "The Runtime endpoint URL for this model version.", + "type": "object" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "activeVersion": { + "description": "The version ID currently marked as active.", + "type": "string" + } + } + }, + "ApplicationsInfoList": { + "description": "List of Application Infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "ProductionOrStagingEndpointInfo": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointInfo" + } + ] + }, + "EndpointInfo": { + "type": "object", + "description": "The base class \"ProductionOrStagingEndpointInfo\" inherits from.", + "properties": { + "versionId": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "type": "boolean" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "region": { + "description": "The target region that the application is published to.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "string" + }, + "endpointRegion": { + "type": "string", + "description": "The endpoint's region." + }, + "failedRegions": { + "type": "string", + "description": "Regions where publishing failed." + }, + "publishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string" + } + } + }, + "AvailableEndpoints": { + "type": "object", + "description": "Collection of endpoint URLs where the selected application is deployed to.", + "additionalProperties": { + "type": "string" + } + }, + "AvailableCulture": { + "description": "Available culture for using in a new application.", + "type": "object", + "properties": { + "name": { + "description": "The language name.", + "type": "string" + }, + "code": { + "description": "The ISO value for the language.", + "type": "string" + } + } + }, + "AvailableCultures": { + "type": "array", + "description": "A list of available application cultures.", + "items": { + "$ref": "#/definitions/AvailableCulture" + } + }, + "AvailableDomains": { + "description": "A list of available application domains.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationUsageScenarios": { + "description": "A list of possible application usage scenarios.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationSettings": { + "description": "The application settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys for billing purposes.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "isPublic" + } + }, + "required": [ + "id", + "public" + ] + }, + "PublishSettings": { + "description": "The application publish settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the sentiment of the input utterance along with the response", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSentimentAnalysisEnabled" + }, + "speech": { + "description": "Enables speech priming in your app", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpeechEnabled" + }, + "spellChecker": { + "description": "Enables spell checking of the utterance.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpellCheckerEnabled" + } + }, + "required": [ + "id", + "sentimentAnalysis", + "speech", + "spellChecker" + ] + }, + "AvailablePrebuiltEntityModel": { + "description": "Available Prebuilt entity model for using in an application.", + "type": "object", + "properties": { + "name": { + "description": "The entity name.", + "type": "string" + }, + "description": { + "description": "The entity description and usage information.", + "type": "string" + }, + "examples": { + "description": "Usage examples.", + "type": "string" + } + } + }, + "AvailablePrebuiltEntityModels": { + "description": "List of Available Prebuilt entity models.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrebuiltEntityModel" + } + }, + "EnqueueTrainingResponse": { + "description": "Response model when requesting to train the model.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + } + } + }, + "TrainingStatus": { + "description": "The Training status.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "UpToDate", + "Fail", + "Success" + ] + }, + "ModelTrainingInfo": { + "description": "Model Training Info.", + "type": "object", + "properties": { + "modelId": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the model." + }, + "details": { + "$ref": "#/definitions/ModelTrainingDetails" + } + } + }, + "ModelTrainingDetails": { + "description": "Model Training Details.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + }, + "exampleCount": { + "description": "The count of examples used to train the model.", + "type": "integer" + }, + "trainingDateTime": { + "description": "When the model was trained.", + "type": "string", + "format": "date-time" + }, + "failureReason": { + "description": "Reason for the training failure.", + "type": "string" + } + } + }, + "ModelTrainingInfoList": { + "description": "List of Model Training Infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelTrainingInfo" + } + }, + "UserAccessList": { + "description": "List of user permissions.", + "type": "object", + "properties": { + "owner": { + "type": "string", + "description": "The email address of owner of the application." + }, + "emails": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UserCollaborator": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email address of the user." + } + } + }, + "CollaboratorsArray": { + "type": "object", + "properties": { + "emails": { + "type": "array", + "description": "The email address of the users.", + "items": { + "type": "string" + } + } + } + }, + "OperationStatus": { + "description": "Response of an Operation status.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Status Code.", + "enum": [ + "Failed", + "FAILED", + "Success" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OperationStatusType" + } + }, + "message": { + "type": "string", + "description": "Status details." + } + } + }, + "ErrorResponse": { + "description": "Error response when invoking an operation on the API.", + "type": "object", + "properties": { + "errorType": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "OperationError": { + "description": "Operation error details when invoking an operation on the API.", + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "PrebuiltDomainsList": { + "description": "List of Prebuilt Domains.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomain" + } + }, + "PrebuiltDomain": { + "description": "Prebuilt Domain.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "culture": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + }, + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + } + } + }, + "PrebuiltDomainItem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "GuidList": { + "description": "List of IDs (GUID)", + "type": "array", + "items": { + "$ref": "#/definitions/GuidResponse" + } + }, + "EntityRoleCreateObject": { + "description": "Object model for creating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "RegexModelCreateObject": { + "description": "Model object for creating a regular expression entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regular expression entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelCreateObject": { + "description": "Model object for creating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExplicitListItemCreateObject": { + "description": "Object model for creating an explicit (exception) list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "RegexModelUpdateObject": { + "description": "Model object for updating a regular expression entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regular expression entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelUpdateObject": { + "description": "Model object for updating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EntityRoleUpdateObject": { + "description": "Object model for updating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "ExplicitListItemUpdateObject": { + "description": "Model object for updating an explicit (exception) list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "PatternRuleCreateObject": { + "description": "Object model for creating a pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleUpdateObject": { + "description": "Object model for updating a pattern.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "RegexEntityExtractor": { + "description": "Regular Expression Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Regex Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "regexPattern": { + "description": "The Regular Expression entity pattern.", + "type": "string" + } + } + }, + "RegexEntityExtractorList": { + "description": "List of Regular Expression Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "PatternAnyEntityExtractor": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Pattern.Any Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "explicitList": { + "$ref": "#/definitions/ExplicitListItemList" + } + } + }, + "PatternAnyEntityExtractorList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "EntityRole": { + "description": "Entity extractor role", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The entity role ID.", + "type": "string" + }, + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "EntityRoleList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityRole" + } + }, + "ExplicitListItem": { + "description": "Explicit (exception) list item", + "type": "object", + "properties": { + "id": { + "format": "int64", + "description": "The explicit list item ID.", + "type": "integer" + }, + "explicitListItem": { + "description": "The explicit list item value.", + "type": "string" + } + } + }, + "ExplicitListItemList": { + "description": "List of explicit (exception) list items", + "type": "array", + "items": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "ExplicitListItemIDResponse": { + "description": "The ID of the created explicit list item.", + "type": "integer", + "x-nullable": false + }, + "PatternRuleInfo": { + "description": "Pattern rule", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleList": { + "description": "List of patterns", + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "ExamplesPerModelResponseObject": { + "description": "A list of example utterances per model.", + "type": "array", + "items": { + "$ref": "#/definitions/LabelTextObject" + } + }, + "LabelTextObject": { + "description": "An object containing the example utterance's text.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the Label." + }, + "text": { + "type": "string", + "description": "The text of the label." + } + } + }, + "FeaturesPerModelResponseObject": { + "description": "A list of feature information objects per model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFeatureInformation" + } + }, + "ModelFeatureInformation": { + "description": "An object containing the model feature information either the model name or feature name.", + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model used." + }, + "featureName": { + "type": "string", + "description": "The name of the feature used." + } + } + }, + "JsonModelFeatureInformation": { + "description": "An object containing the model feature information either the model name or feature name.", + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model used." + }, + "featureName": { + "type": "string", + "description": "The name of the feature used." + } + } + }, + "PatternAny": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "explicitList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "RegexEntity": { + "description": "Regular Expression Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "regexPattern": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PrebuiltEntity": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PatternRule": { + "description": "Pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + }, + "AppVersionSettingObject": { + "description": "Object model of an application version setting.", + "type": "object", + "properties": { + "name": { + "description": "The application version setting name.", + "type": "string" + }, + "value": { + "description": "The application version setting value.", + "type": "string" + } + } + }, + "AzureAccountInfoList": { + "description": "List of Azure account info objects.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureAccountInfoObject" + } + }, + "AzureAccountInfoObject": { + "description": "Defines the Azure account information object.", + "type": "object", + "required": [ + "azureSubscriptionId", + "resourceGroup", + "accountName" + ], + "properties": { + "azureSubscriptionId": { + "description": "The id for the Azure subscription.", + "type": "string" + }, + "resourceGroup": { + "description": "The Azure resource group name.", + "type": "string" + }, + "accountName": { + "description": "The Azure account name.", + "type": "string" + } + } + } + }, + "parameters": { + "AppIdInPath": { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The application ID.", + "x-ms-parameter-location": "method" + }, + "VersionIdInPath": { + "name": "versionId", + "in": "path", + "description": "The version ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CEntityIdInPath": { + "name": "cEntityId", + "in": "path", + "description": "The composite entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "HEntityIdInPath": { + "name": "hEntityId", + "in": "path", + "description": "The hierarchical entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "IntentIdInPath": { + "name": "intentId", + "in": "path", + "description": "The intent classifier ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "EntityIdInPath": { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "SlotNameInPath": { + "name": "slotName", + "in": "path", + "description": "The publishing slot name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SkipInPath": { + "name": "skip", + "in": "query", + "description": "The number of entries to skip. Default value is 0.", + "type": "integer", + "default": 0, + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "TakeInPath": { + "name": "take", + "in": "query", + "description": "The number of entries to return. Maximum page size is 500. Default is 100.", + "type": "integer", + "default": 100, + "minimum": 0, + "maximum": 500, + "x-ms-parameter-location": "method" + }, + "ForcePath": { + "name": "force", + "in": "query", + "description": "A flag to indicate whether to force an operation.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "BearerAuthPath": { + "name": "Authorization", + "in": "header", + "description": "The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddApplicationRequest.json new file mode 100644 index 000000000000..41fb8dce349f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddApplicationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "applicationCreateObject": { + "culture": "en-us", + "domain": "Comics", + "description": "New LUIS App", + "usageScenario": "IoT", + "name": "New LUIS App" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/9e6703ec-56fe-48ce-8a72-10d592f6056d" + }, + "body": "9e6703ec-56fe-48ce-8a72-10d592f6056d" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json new file mode 100644 index 000000000000..030f7fd033c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "prebuiltDomainCreateObject": { + "culture": "en-US", + "domainName": "Web" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000" + }, + "body": "00000000-0000-0000-0000-000000000000" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json new file mode 100644 index 000000000000..d4b87f77d103 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json new file mode 100644 index 000000000000..97528c73eec3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/octet-stream" + }, + "body": "\"Query\",\"UTC DateTime\",\"Response\" \"hello, world!\",01/31/2017 17:17:41,\"{ \"\"query\"\": \"\"Hello, World!\"\", \"\"topScoringIntent\"\": { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, \"\"intents\"\": [ { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, { \"\"intent\"\": \"\"BookFlight\"\", \"\"score\"\": 0.002136109 }, { \"\"intent\"\": \"\"GetWeather\"\", \"\"score\"\": 0.00142168161 } ], \"\"entities\"\": []}\"" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json new file mode 100644 index 000000000000..0ad1e00a6681 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "English", + "code": "en-us" + }, + { + "name": "Chinese", + "code": "zh-cn" + }, + { + "name": "French", + "code": "fr-fr" + }, + { + "name": "French Canadian", + "code": "fr-ca" + }, + { + "name": "Spanish", + "code": "es-es" + }, + { + "name": "Spanish Mexican", + "code": "es-mx" + }, + { + "name": "Italian", + "code": "it-it" + }, + { + "name": "German", + "code": "de-de" + }, + { + "name": "Japanese", + "code": "ja-jp" + }, + { + "name": "Brazilian Portuguese", + "code": "pt-br" + }, + { + "name": "Korean", + "code": "ko-kr" + }, + { + "name": "Dutch", + "code": "nl-nl" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json new file mode 100644 index 000000000000..7b30aa76981a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "Booking & Reference", + "Business", + "Comics", + "Communication", + "Education", + "Entertainment", + "Finance", + "Food & Nutrition", + "Gaming", + "Health & Fitness", + "Home Automation", + "Media & Video", + "Medical", + "Music & Audio", + "Navigation & Maps", + "News & Magazines", + "Personalization", + "Productivity", + "Real Estate", + "Scheduler", + "Shopping", + "Social Network", + "Sports", + "Telecom", + "Tools", + "Transportation", + "Translation", + "Travel & Local", + "Weather", + "Others" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json new file mode 100644 index 000000000000..5374060f0e95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "name": "MyFirstDummyAp", + "description": "This is my first dummy application", + "culture": "en-us", + "usageScenario": "IoT", + "domain": "Comics", + "versionsCount": 3, + "createdDateTime": "2017-01-31T16:15:54Z", + "endpoints": { + "PRODUCTION": { + "versionId": "0.1", + "isStaging": false, + "endpointUrl": "DummyUrl", + "endpointRegion": "westus", + "assignedEndpointKey": "", + "publishedDateTime": "2017-02-19T17:09:14Z" + } + }, + "endpointHitsCount": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json new file mode 100644 index 000000000000..1cf9c19dc47d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "public": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json new file mode 100644 index 000000000000..4177f38f46e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "IoT", + "Bot", + "Mobile Application", + "Other" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json new file mode 100644 index 000000000000..2cd6815f6b46 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "name": "MyFirstDummyApp", + "description": "This is my first dummy application", + "culture": "en-us", + "usageScenario": "IoT", + "domain": "Comics", + "versionsCount": 3, + "createdDateTime": "2017-01-31T16:15:54Z", + "endpoints": { + "PRODUCTION": { + "versionId": "0.1", + "isStaging": false, + "endpointUrl": "DummyUrl", + "assignedEndpointKey": "", + "endpointRegion": "westus", + "publishedDateTime": "2017-02-19T17:09:14Z" + } + }, + "endpointHitsCount": 0 + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json new file mode 100644 index 000000000000..4248d6289988 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "culture": "{culture}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "taxi", + "culture": "en-us", + "description": "A custom prebuilt domain for taxi booking", + "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux", + "intents": [ + { + "name": "book_taxi", + "description": "Requests/Books taxi", + "examples": "book taxi x on friday at 6 pm" + }, + { + "name": "cancel_taxi", + "description": "Cancels taxi request", + "examples": "I just called an taxi SUV , please cancel, Cancel my taxi" + } + ], + "entities": [ + { + "name": "from_place_name", + "description": "Route starting point", + "examples": "find taxi x to take me to 9th street from space needle" + } + ] + }, + { + "name": "weather", + "culture": "en-us", + "description": "A custom prebuilt domain that gets weather forecast and condition", + "examples": "Show me the weather for this weekend, What's the weather?", + "intents": [ + { + "name": "get_forecast", + "description": "Gets weather forecast", + "examples": "What's the weather like tomorrow?" + }, + { + "name": "get_condition", + "description": "Gets weather condition", + "examples": "what's the average temperature in India in September?" + } + ], + "entities": [ + { + "name": "location", + "description": "Location of the queried weather", + "examples": "What's the weather like in Minneapolis" + }, + { + "name": "unit", + "description": "Temperature measurement unit", + "examples": "Please change the weather from Fahrenheit to Celsius" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json new file mode 100644 index 000000000000..08ed90e3c9cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "taxi", + "culture": "en-us", + "description": "A custom prebuilt domain for taxi booking", + "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux", + "intents": [ + { + "name": "book_taxi", + "description": "Requests/Books taxi", + "examples": "book taxi x on friday at 6 pm" + }, + { + "name": "cancel_taxi", + "description": "Cancels taxi request", + "examples": "I just called an taxi SUV , please cancel, Cancel my taxi" + } + ], + "entities": [ + { + "name": "from_place_name", + "description": "Route starting point", + "examples": "find taxi x to take me to 9th street from space needle" + } + ] + }, + { + "name": "weather", + "culture": "en-us", + "description": "A custom prebuilt domain that gets weather forecast and condition", + "examples": "Show me the weather for this weekend, What's the weather?", + "intents": [ + { + "name": "get_forecast", + "description": "Gets weather forecast", + "examples": "What's the weather like tomorrow?" + }, + { + "name": "get_condition", + "description": "Gets weather condition", + "examples": "what's the average temperature in India in September?" + } + ], + "entities": [ + { + "name": "location", + "description": "Location of the queried weather", + "examples": "What's the weather like in Minneapolis" + }, + { + "name": "unit", + "description": "Temperature measurement unit", + "examples": "Please change the weather from Fahrenheit to Celsius" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json new file mode 100644 index 000000000000..6b1631e49726 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "westus": "https://westus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "eastus2": "https://eastus2.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "westcentralus": "https://westcentralus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "southeastasia": "https://southeastasia.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json new file mode 100644 index 000000000000..9d62ff8c21d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKeys": [], + "endpointUrls": { + "English": "EnglishDummyURL", + "Chinese": "ChineseDummyURL", + "French": "FrenchDummyURL", + "Spanish": "SpanishDummyURL", + "Italian": "ItalianDummyURL" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json new file mode 100644 index 000000000000..89f4df476993 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulImportApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulImportApplicationRequest.json new file mode 100644 index 000000000000..3f023c906e7d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulImportApplicationRequest.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appName": "Test LUIS App", + "luisApp": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" + }, + "body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json new file mode 100644 index 000000000000..fe5a3d4fcfc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "11be6373fca44ded80fbe2afa8597c18", + "applicationPublishObject": { + "versionId": "0.1", + "isStaging": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "isStaging": false, + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18", + "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", + "endpointRegion": "westus, cus", + "failedRegions": null, + "publishedDateTime": "2017-11-28T19:20:28Z" + } + }, + "207": { + "headers": {}, + "body": { + "isStaging": false, + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18", + "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", + "endpointRegion": "westus, cus", + "failedRegions": "cus", + "publishedDateTime": "2017-11-28T19:20:28Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json new file mode 100644 index 000000000000..52a47756fda7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "applicationUpdateObject": { + "name": "LUIS App name updated", + "description": "LUIS App description updated" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json new file mode 100644 index 000000000000..662d17154fda --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "applicationSettingUpdateObject": { + "public": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json new file mode 100644 index 000000000000..95f8c39bacf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "publishSettingUpdateObject": { + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json new file mode 100644 index 000000000000..9a7220daa4e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "exampleLabelObject": { + "text": "whats the weather in buenos aires?", + "intentName": "WeatherInPlace", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 34 + } + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -11 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..bc2a357b807a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", + "versionId": "0.1", + "exampleLabelObjectArray": [ + { + "text": "whats the weather in seattle?", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 29 + } + ], + "intentName": "WeatherInPlace" + }, + { + "text": "whats the weather in buenos aires?", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 34 + } + ], + "intentName": "WeatherInPlace" + } + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "value": { + "UtteranceText": "whats the weather in seattle?", + "ExampleId": -728104 + }, + "hasError": false + }, + { + "value": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -5313943 + }, + "hasError": false + } + ] + }, + "207": { + "headers": {}, + "body": [ + { + "hasError": true, + "error": { + "code": "FAILED", + "message": "whats the weather in seattle?. Error: The intent classifier InvalidIntent does not exist in the selected application" + } + }, + { + "value": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -5313943 + }, + "hasError": false + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json new file mode 100644 index 000000000000..8ee37c1f5b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "exampleId": -5313926 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json new file mode 100644 index 000000000000..a0a43d373b31 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": -12, + "text": "what's the weather like in seattle?", + "tokenizedText": [ + "what", + "'", + "s", + "the", + "weather", + "like", + "in", + "seattle", + "?" + ], + "intentLabel": "GetWeather", + "entityLabels": [ + { + "entityName": "Location", + "startTokenIndex": 7, + "endTokenIndex": 7 + } + ], + "intentPredictions": [ + { + "name": "GetWeather", + "score": 1 + }, + { + "name": "None", + "score": 0.21 + }, + { + "name": "BookFlight", + "score": 0 + } + ], + "entityPredictions": [ + { + "entityName": "Location", + "startTokenIndex": 7, + "endTokenIndex": 7, + "phrase": "seattle" + } + ] + }, + { + "id": -11, + "text": "book me a flight from cairo to redmond next thursday", + "tokenizedText": [ + "book", + "me", + "a", + "flight", + "from", + "cairo", + "to", + "redmond", + "next", + "thursday" + ], + "intentLabel": "BookFlight", + "entityLabels": [ + { + "entityName": "Location", + "startTokenIndex": 7, + "endTokenIndex": 7, + "role": "To" + }, + { + "entityName": "Location", + "startTokenIndex": 5, + "endTokenIndex": 5, + "role": "from" + } + ], + "intentPredictions": [ + { + "name": "BookFlight", + "score": 0.93 + }, + { + "name": "None", + "score": 0.41 + }, + { + "name": "GetWeather", + "score": 0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 8, + "endTokenIndex": 9, + "phrase": "next thursday" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json new file mode 100644 index 000000000000..2ed286e00f91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistCreateObject": { + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true + } + }, + "responses": { + "201": { + "headers": {}, + "body": 1823 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..9a2cbf9d87f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json new file mode 100644 index 000000000000..3a70755fff0f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skipIn": 0, + "takeIn": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "phraselistFeatures": [ + { + "id": 5341, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + }, + { + "id": 74598, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + ], + "patternFeatures": [ + { + "id": 81231, + "name": "EmailPattern", + "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", + "isActive": true, + "enabledForAllModels": true + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json new file mode 100644 index 000000000000..3a6f5e4b33e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 321421, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + }, + { + "id": 97832, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..52649ceb5c3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 178384, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..9faceb14a074 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384, + "phraselistUpdateObject": { + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isActive": false, + "isExchangeable": true, + "enabledForAllModels": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..305e4023e1e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltExtractorNames": [ + "datetimeV2" + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json new file mode 100644 index 000000000000..d6673649257b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "prebuiltDomainObject": { + "domainName": "Web" + } + }, + "responses": { + "201": { + "headers": {}, + "body": [ + "2639049a-e41d-4285-a3c6-8a17ed299473", + "200d6173-ecfa-4967-bf95-3c319902dc52", + "f80aa9ba-64c8-4a36-8cc5-92010d0aadf1", + "f50d6f0f-b2dd-4973-9270-c114312b3a10" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json new file mode 100644 index 000000000000..f2399d68b3de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0", + "prebuiltDomainModelCreateObject": { + "domainName": "Calendar", + "modelName": "Add" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json new file mode 100644 index 000000000000..f059dc322ee5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0", + "prebuiltDomainModelCreateObject": { + "domainName": "Camera", + "modelName": "AppName" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json new file mode 100644 index 000000000000..57e58c5c4f0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationCreateObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json new file mode 100644 index 000000000000..2d7ee0655191 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationCreateObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json new file mode 100644 index 000000000000..447ac7fba5d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "wordListCreateObject": { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877" + }, + "body": 6134877 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json new file mode 100644 index 000000000000..dace6ef7a4de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "closedListModelCreateObject": { + "name": "States", + "subLists": [ + { + "canonicalForm": "New York", + "list": [ + "NY", + "New York" + ] + }, + { + "canonicalForm": "Washington", + "list": [ + "Washington", + "WA" + ] + }, + { + "canonicalForm": "California", + "list": [ + "California", + "CA", + "Calif.", + "Cal." + ] + } + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": "8713b104-78ec-4c4f-9f96-f2e53562cc16" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..d6f6182023a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json new file mode 100644 index 000000000000..2bb04cce834e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "compositeChildModelCreateObject": { + "name": "dateFrame" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..cf93fe1b64a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/compositeentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..0f5a94f1d798 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json new file mode 100644 index 000000000000..646d7054e2ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "childEntityModelCreateObject": { + "name": "Day", + "children": [], + "instanceOf": "number" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json new file mode 100644 index 000000000000..596f30243198 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityModelCreateObject": { + "name": "DayOfWeek", + "children": [ + { + "name": "Day", + "instanceOf": "datetimeV2" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json new file mode 100644 index 000000000000..758e3e4565b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..01739e859d51 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json new file mode 100644 index 000000000000..360e9f0bc1aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentCreateObject": { + "name": "BookFlight" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json new file mode 100644 index 000000000000..b213febc28f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "extractorCreateObject": { + "name": "AirportCodeRegex", + "explicitList": [ + "item 1", + "item 2" + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..f644416634c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..e98ab4359748 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "item": { + "explicitListItem": "item 1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/explicitlist/8645" + }, + "body": 8645 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..98ca2610c499 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json new file mode 100644 index 000000000000..01886097f539 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityExtractorCreateObj": { + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..19028d004f50 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/regexentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json new file mode 100644 index 000000000000..51dc2f145c5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json new file mode 100644 index 000000000000..7d3835d1c72c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "cChildId": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json new file mode 100644 index 000000000000..36253c0b0e77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..eb058743cbdb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json new file mode 100644 index 000000000000..527791465895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json new file mode 100644 index 000000000000..77bcdbd7c486 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationDeleteObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json new file mode 100644 index 000000000000..160694dc02c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json new file mode 100644 index 000000000000..79283b0975b4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..22c45f4c81de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json new file mode 100644 index 000000000000..90d8a50f666a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationDeleteObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json new file mode 100644 index 000000000000..396d8d3b3b23 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json new file mode 100644 index 000000000000..527791465895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..f5052475dd3f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 543211 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json new file mode 100644 index 000000000000..7557e0d93a28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "domainName": "Web" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json new file mode 100644 index 000000000000..208e4484deae --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json new file mode 100644 index 000000000000..8a16ae29c73a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteSublistRequest.json new file mode 100644 index 000000000000..0d3bf08baf1e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulDeleteSublistRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "subListId": 123 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json new file mode 100644 index 000000000000..0d50a283b553 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "11be6373fca44ded80fbe2afa8597c18", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json new file mode 100644 index 000000000000..488104e50742 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json new file mode 100644 index 000000000000..4ee81b36ccf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json new file mode 100644 index 000000000000..e3caf94b3199 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json new file mode 100644 index 000000000000..7bbe97aef02b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", + "name": "BookFlight", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json new file mode 100644 index 000000000000..edab6c2a1d44 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", + "name": "BookFlight", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json new file mode 100644 index 000000000000..9b96c5e3b6f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 1", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 2", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [], + "roles": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..51985bdac0e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json new file mode 100644 index 000000000000..1ae466748e94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "Guid regex", + "regexPattern": "[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{3}-[0-9A-F]{12}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json new file mode 100644 index 000000000000..e1e9a393772e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "geography", + "description": "Continents, Countries, Cities, Post codes, and other points of interest", + "examples": "Antarctica, Portugal, Dubai, Sanjiang County, Lake Pontchartrain, CB3 0DS" + }, + { + "name": "datetime", + "description": "Dates and times, resolved to a canonical form", + "examples": "June 23, 1976, Jul 11 2012, 7 AM, 6:49 PM, tomorrow at 7 AM" + }, + { + "name": "email", + "description": "Email Addresses", + "examples": "user@site.net, user_name@mysite.com.eg" + }, + { + "name": "url", + "description": "Websites URLs", + "examples": "www.website.com, http://website.net?name=my_name&age=10, https://www.mywebsite.net.eg/page" + }, + { + "name": "phoneNumber", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json new file mode 100644 index 000000000000..e7a6acd06c8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "8713b104-78ec-4c4f-9f96-f2e53562cc16" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json new file mode 100644 index 000000000000..50832117a604 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json new file mode 100644 index 000000000000..03d1d14f36bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json new file mode 100644 index 000000000000..23455912afe2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json new file mode 100644 index 000000000000..ea428c098af3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "Camera.AppName", + "typeId": 1, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Add" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json new file mode 100644 index 000000000000..df2704a27f18 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json new file mode 100644 index 000000000000..e81d514c3e5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "1aa813da-8d36-4d16-bb13-d6f193290fea", + "name": "Calendar.Find", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Find" + }, + { + "id": "d02b2e38-6b3c-412e-bf9e-f6770a40c9a0", + "name": "Calendar.Location", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Location", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json new file mode 100644 index 000000000000..6bc5840cc97f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json new file mode 100644 index 000000000000..2a90b679eea1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "children": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "typeId": 1, + "readableType": "Child Entity Extractor", + "name": "Day", + "instanceOf": "datetimeV2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json new file mode 100644 index 000000000000..0c103cc44e24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json @@ -0,0 +1,2643 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "text": "hey", + "tokenizedText": [ + "hey" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "2-2-2017", + "tokenizedText": [ + "2", + "-", + "2", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.88 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "2-2-2017" + } + ] + }, + { + "text": "maybe find me an airport first", + "tokenizedText": [ + "maybe", + "find", + "me", + "an", + "airport", + "first" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "as", + "tokenizedText": [ + "as" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + } + ] + }, + { + "text": "find airport with code atl", + "tokenizedText": [ + "find", + "airport", + "with", + "code", + "atl" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "atl" + } + ] + }, + { + "text": "change hotel location to madrid", + "tokenizedText": [ + "change", + "hotel", + "location", + "to", + "madrid" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.24 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "madrid" + } + ] + }, + { + "text": "ok, find me an airport", + "tokenizedText": [ + "ok", + ",", + "find", + "me", + "an", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "eze", + "tokenizedText": [ + "eze" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.68 + }, + { + "name": "None", + "score": 0.29 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "eze" + } + ] + }, + { + "text": "today", + "tokenizedText": [ + "today" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.64 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "today" + } + ] + }, + { + "text": "buenos aires", + "tokenizedText": [ + "buenos", + "aires" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.16 + }, + { + "name": "WeatherInPlace", + "score": 0.07 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "hi there", + "tokenizedText": [ + "hi", + "there" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.37 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "05-28-2017", + "tokenizedText": [ + "05", + "-", + "28", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.85 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "05-28-2017" + } + ] + }, + { + "text": "tomorrow", + "tokenizedText": [ + "tomorrow" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.6 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "tomorrow" + } + ] + }, + { + "text": "tell me the weather in san francisco", + "tokenizedText": [ + "tell", + "me", + "the", + "weather", + "in", + "san", + "francisco" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.99 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "san francisco" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "san francisco" + } + ] + }, + { + "text": "find me a hotel in barcelona", + "tokenizedText": [ + "find", + "me", + "a", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "barcelona" + } + ] + }, + { + "text": "dme", + "tokenizedText": [ + "dme" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.62 + }, + { + "name": "FindAirportByCode", + "score": 0.09 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "dude", + "tokenizedText": [ + "dude" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "sorry, find me airport juj", + "tokenizedText": [ + "sorry", + ",", + "find", + "me", + "airport", + "juj" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "juj" + } + ] + }, + { + "text": "madrid", + "tokenizedText": [ + "madrid" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.52 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "search for airport", + "tokenizedText": [ + "search", + "for", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "what's the time in miami?", + "tokenizedText": [ + "what", + "'", + "s", + "the", + "time", + "in", + "miami", + "?" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "miami" + } + ] + }, + { + "text": "next monday", + "tokenizedText": [ + "next", + "monday" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.3 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 1, + "phrase": "next monday" + } + ] + }, + { + "text": "search hotels, seattle", + "tokenizedText": [ + "search", + "hotels", + ",", + "seattle" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "None", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "seattle" + } + ] + }, + { + "text": "change location to madrid", + "tokenizedText": [ + "change", + "location", + "to", + "madrid" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.03 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + } + ] + }, + { + "text": "search hotels, \"next day\"", + "tokenizedText": [ + "search", + "hotels", + ",", + "\"", + "next", + "day", + "\"" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 0.99 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find a deluxe room in a 3 stars hotel in barcelona please", + "tokenizedText": [ + "find", + "a", + "deluxe", + "room", + "in", + "a", + "3", + "stars", + "hotel", + "in", + "barcelona", + "please" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "RoomType", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "deluxe" + }, + { + "entityName": "Category", + "startTokenIndex": 6, + "endTokenIndex": 7, + "phrase": "3 stars" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 10, + "endTokenIndex": 10, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 10, + "endTokenIndex": 10, + "phrase": "barcelona" + } + ] + }, + { + "text": "time miami", + "tokenizedText": [ + "time", + "miami" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.14 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona from today", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona", + "from", + "today" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "Checkin", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + } + ] + }, + { + "text": "search for 5 start hotels in jujuy", + "tokenizedText": [ + "search", + "for", + "5", + "start", + "hotels", + "in", + "jujuy" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "5" + }, + { + "entityName": "Category", + "startTokenIndex": 2, + "endTokenIndex": 3, + "phrase": "5 start" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "jujuy" + } + ] + }, + { + "text": "search hotels, past tomorrow", + "tokenizedText": [ + "search", + "hotels", + ",", + "past", + "tomorrow" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "tomorrow" + } + ] + }, + { + "text": "loz", + "tokenizedText": [ + "loz" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "loz" + } + ] + }, + { + "text": "show me the weather", + "tokenizedText": [ + "show", + "me", + "the", + "weather" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "dme airport", + "tokenizedText": [ + "dme", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "None", + "score": 0.04 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "dme" + } + ] + }, + { + "text": "find zzz airport", + "tokenizedText": [ + "find", + "zzz", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 1, + "endTokenIndex": 1, + "phrase": "zzz" + } + ] + }, + { + "text": "change location to miami", + "tokenizedText": [ + "change", + "location", + "to", + "miami" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.08 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "miami" + } + ] + }, + { + "text": "find hotel from today till next monday", + "tokenizedText": [ + "find", + "hotel", + "from", + "today", + "till", + "next", + "monday" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Checkin", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "today" + }, + { + "entityName": "Checkout", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "next monday" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "next monday" + } + ] + }, + { + "text": "sorry, find me airport with code bcn", + "tokenizedText": [ + "sorry", + ",", + "find", + "me", + "airport", + "with", + "code", + "bcn" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 7, + "endTokenIndex": 7, + "phrase": "bcn" + } + ] + }, + { + "text": "actionresult = \"weather in aisjj3o9f2\"", + "tokenizedText": [ + "actionresult", + "=", + "\"", + "weather", + "in", + "aisjj3o9f2", + "\"" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.82 + }, + { + "name": "FindHotels", + "score": 0.02 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "aisjj3o9f2" + } + ] + }, + { + "text": "[object object]", + "tokenizedText": [ + "[", + "object", + "object", + "]" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.06 + }, + { + "name": "FindHotels", + "score": 0.05 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "05-27-2017", + "tokenizedText": [ + "05", + "-", + "27", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.84 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "05-27-2017" + } + ] + }, + { + "text": "change hotel location", + "tokenizedText": [ + "change", + "hotel", + "location" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.03 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "asdttt", + "tokenizedText": [ + "asdttt" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "whats the time in miami", + "tokenizedText": [ + "whats", + "the", + "time", + "in", + "miami" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "miami" + } + ] + }, + { + "text": "time in brasil", + "tokenizedText": [ + "time", + "in", + "brasil" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "brasil" + } + ] + }, + { + "text": "mia", + "tokenizedText": [ + "mia" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "3-3-2017", + "tokenizedText": [ + "3", + "-", + "3", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.87 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "3-3-2017" + } + ] + }, + { + "text": "how is the weather in buenos aires?", + "tokenizedText": [ + "how", + "is", + "the", + "weather", + "in", + "buenos", + "aires", + "?" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.97 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + } + ] + }, + { + "text": "n", + "tokenizedText": [ + "n" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find aaa airport", + "tokenizedText": [ + "find", + "aaa", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 1, + "endTokenIndex": 1, + "phrase": "aaa" + } + ] + }, + { + "text": "find airport lhr", + "tokenizedText": [ + "find", + "airport", + "lhr" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "lhr" + } + ] + }, + { + "text": "juj", + "tokenizedText": [ + "juj" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "juj" + } + ] + }, + { + "text": "adweqwe", + "tokenizedText": [ + "adweqwe" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in madrid for today", + "tokenizedText": [ + "find", + "hotel", + "in", + "madrid", + "for", + "today" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + }, + { + "entityName": "Checkin", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + } + ] + }, + { + "text": "find airport zzz", + "tokenizedText": [ + "find", + "airport", + "zzz" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "zzz" + } + ] + }, + { + "text": "search hotels, \"past tomorrow\"", + "tokenizedText": [ + "search", + "hotels", + ",", + "\"", + "past", + "tomorrow", + "\"" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "tomorrow" + } + ] + }, + { + "text": "search for 5 stars hotels in barcelo", + "tokenizedText": [ + "search", + "for", + "5", + "stars", + "hotels", + "in", + "barcelo" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Category", + "startTokenIndex": 2, + "endTokenIndex": 3, + "phrase": "5 stars" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "barcelo" + } + ] + }, + { + "text": "airport", + "tokenizedText": [ + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "change location", + "tokenizedText": [ + "change", + "location" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.19 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "11/11/2017", + "tokenizedText": [ + "11", + "/", + "11", + "/", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.9 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "11/11/2017" + } + ] + }, + { + "text": "tell me the weather in new york", + "tokenizedText": [ + "tell", + "me", + "the", + "weather", + "in", + "new", + "york" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + }, + { + "entityName": "Retrieve Sample List", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json new file mode 100644 index 000000000000..0bd9783b948a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "modelId": "e4770e43-233a-48ad-a1fa-54f4f97eff9f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 10002, + "text": "Lorem ipsum dolor sit amet" + }, + { + "id": 10003, + "text": "consectetur adipiscing elit" + }, + { + "id": 10004, + "text": "sed do eiusmod tempor incididunt" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json new file mode 100644 index 000000000000..cb3138df0672 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}", + "hChildId": "{hChildId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "ef278a6c-d94f-4d20-a602-cf53d0acf0f5", + "name": "From", + "typeId": 6, + "readableType": "Hierarchical Child Entity Extractor" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json new file mode 100644 index 000000000000..85d6eba6f6f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json new file mode 100644 index 000000000000..dd9c6f7f42ba --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json new file mode 100644 index 000000000000..1b0fc00770de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json new file mode 100644 index 000000000000..8836884506bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json new file mode 100644 index 000000000000..1716e6373d98 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "TestIntent", + "typeId": 0, + "readableType": "Intent Classifier" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json new file mode 100644 index 000000000000..a0cd5f3a1bbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "text": "hey", + "tokenizedText": [ + "hey" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "2-2-2017", + "tokenizedText": [ + "2", + "-", + "2", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.88 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "2-2-2017" + } + ] + }, + { + "text": "maybe find me an airport first", + "tokenizedText": [ + "maybe", + "find", + "me", + "an", + "airport", + "first" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "as", + "tokenizedText": [ + "as" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json new file mode 100644 index 000000000000..e0431eda30b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..71f5e66dd804 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a", + "itemId": 76451 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 76451, + "explicitListItem": "item 2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..04ca5d9a5ea2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 48674, + "explicitListItem": "item 1" + }, + { + "id": 76451, + "explicitListItem": "item 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json new file mode 100644 index 000000000000..22b050172373 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a065c863-918e-4c56-a267-9aaae3c7dced", + "name": "datetimeV2", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json new file mode 100644 index 000000000000..675614962014 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json new file mode 100644 index 000000000000..dc5341bcfcc7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "closedListModelPatchObject": { + "subLists": [ + { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json new file mode 100644 index 000000000000..41a8e651e259 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "modelUpdateObject": { + "name": "newTest" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json new file mode 100644 index 000000000000..816fd7bb83d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationsUpdateObject": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json new file mode 100644 index 000000000000..64834fe5bd24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationsUpdateObject": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json new file mode 100644 index 000000000000..be1354932eff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "closedListModelUpdateObject": { + "name": "States", + "subLists": [ + { + "canonicalForm": "Texas", + "list": [ + "TX", + "Texas" + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json new file mode 100644 index 000000000000..78be03fe4f4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}", + "compositeModelUpdateObject": { + "name": "Renamed Entity" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..1a460ea7216c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json new file mode 100644 index 000000000000..5a4558d9e82a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "entityModelUpdateObject": { + "name": "New Name", + "instanceOf": "number" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json new file mode 100644 index 000000000000..3f65e0bdc0a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767", + "hierarchicalChildModelUpdateObject": { + "name": "Location::To" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json new file mode 100644 index 000000000000..3ab3ac76e1df --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "modelUpdateObject": { + "name": "Reservation" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..797154c47969 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json new file mode 100644 index 000000000000..a0f7b69a69f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 53435, + "item": { + "explicitListItem": "new item" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json new file mode 100644 index 000000000000..580470d46af4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "patternAnyUpdateObject": { + "name": "New Name", + "explicitList": [ + "item1", + "item2" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json new file mode 100644 index 000000000000..ff26f5a7cffb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "regexEntityUpdateObject": { + "name": "New Name", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateSublistRequest.json new file mode 100644 index 000000000000..cdb7a3de86bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulUpdateSublistRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "subListId": 123, + "wordListBaseUpdateObject": { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json new file mode 100644 index 000000000000..57e0c9be86e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json new file mode 100644 index 000000000000..57e0c9be86e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulAddPatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulAddPatternRequest.json new file mode 100644 index 000000000000..663859dde70d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulAddPatternRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..ff74e0a38dff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", + "versionId": "0.1", + "patterns": [ + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json new file mode 100644 index 000000000000..d2d9eb298075 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json new file mode 100644 index 000000000000..a6c9168abd4e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternIds": [ + "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "2126479d-2a98-4d06-a65e-b8799df2dd53" + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json new file mode 100644 index 000000000000..269cebf9bd61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json new file mode 100644 index 000000000000..1829a2e8cdee --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json new file mode 100644 index 000000000000..67ccc3717e0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json new file mode 100644 index 000000000000..fb3997aa2024 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patterns": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json new file mode 100644 index 000000000000..868818ea0bda --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "userToAdd": { + "email": "guest@outlook.com" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json new file mode 100644 index 000000000000..bca79c6b986c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "owner": "owner@email.com", + "emails": [ + "yourname@outlook.com" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json new file mode 100644 index 000000000000..e07a94cd0393 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "userToDelete": { + "email": "guest@outlook.com" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json new file mode 100644 index 000000000000..34444826b73b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "collaborators": { + "emails": [ + "guest@outlook.com", + "invited.user@live.com" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json new file mode 100644 index 000000000000..82d9f72a4578 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json new file mode 100644 index 000000000000..91903957a95b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json new file mode 100644 index 000000000000..bab6b4a286f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json new file mode 100644 index 000000000000..7f98282b81d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json new file mode 100644 index 000000000000..d89c56ce2895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "modelId": "f9b00d5b-1f2d-421e-bc99-5ff192d0b998", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + }, + { + "modelId": "51403af3-5342-4926-abaa-91172a42e075", + "details": { + "statusId": 2, + "status": "UpToDate", + "exampleCount": 12, + "trainingDateTime": "2017-01-31T21:42:02Z" + } + }, + { + "modelId": "b4cf6402-dc79-4ca3-8666-b0007337e92b", + "details": { + "statusId": 1, + "status": "Fail", + "exampleCount": 12, + "failureReason": "FewLabels" + } + }, + { + "modelId": "e8e3135a-acd9-4164-a65c-e2fedbe78cfa", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + }, + { + "modelId": "3291fac9-6368-4c87-9562-e78cae0fa7c6", + "details": { + "statusId": 0, + "status": "Success", + "exampleCount": 12, + "trainingDateTime": "2017-01-31T21:42:02Z" + } + }, + { + "modelId": "a193efac-ab02-49d7-b005-ee717d45c4f1", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json new file mode 100644 index 000000000000..67484006a612 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "202": { + "headers": {}, + "body": { + "statusId": 9, + "status": "Queued" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json new file mode 100644 index 000000000000..c819676e66ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "versionCloneObject": { + "version": "1.0" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1.0" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json new file mode 100644 index 000000000000..0fc41319fb8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json new file mode 100644 index 000000000000..0d0c02e2995e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "utterance": "dummy text" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json new file mode 100644 index 000000000000..388d2eb738e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json new file mode 100644 index 000000000000..5db9fe069442 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "version": "0.1", + "createdDateTime": "2017-08-01T14:34:15Z", + "lastModifiedDateTime": "2017-11-28T20:12:09Z", + "lastTrainedDateTime": "2017-11-28T20:12:12Z", + "lastPublishedDateTime": "2017-11-28T20:12:35Z", + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e", + "assignedEndpointKey": { + "SubscriptionKey": "", + "SubscriptionRegion": "westus", + "SubscriptionName": "" + }, + "externalApiKeys": {}, + "intentsCount": 4, + "entitiesCount": 0, + "endpointHitsCount": 175, + "trainingStatus": "Trained" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json new file mode 100644 index 000000000000..c1afa5393351 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "UseAllTrainingData", + "value": "false" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json new file mode 100644 index 000000000000..53bc68f9173f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "version": "0.1", + "createdDateTime": "2017-08-01T14:34:15Z", + "lastModifiedDateTime": "2017-11-28T20:12:09Z", + "lastTrainedDateTime": "2017-11-28T20:12:12Z", + "lastPublishedDateTime": "2017-11-28T20:12:35Z", + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e", + "assignedEndpointKey": { + "SubscriptionKey": "", + "SubscriptionRegion": "westus", + "SubscriptionName": "" + }, + "externalApiKeys": {}, + "intentsCount": 4, + "entitiesCount": 0, + "endpointHitsCount": 175, + "trainingStatus": "Trained" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json new file mode 100644 index 000000000000..d1677a179789 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json @@ -0,0 +1,308 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2", + "luisApp": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" + }, + "body": "0.2" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json new file mode 100644 index 000000000000..27f8a7a8e279 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "versionUpdateObject": { + "version": "1.0" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json new file mode 100644 index 000000000000..e6e76349b17f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "listOfAppVersionSettingObject": [ + { + "name": "UseAllTrainingData", + "value": "false" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md index 1bd6bea985e6..a8c6c825e2bc 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: authoring_2_0 + - tag: authoring_3_0_preview ``` ### Tag: authoring_2_0 and go @@ -23,4 +24,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'authoring_3_0_preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/luis/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md index 58b49fc6c834..bd3c1cdb639d 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md @@ -5,12 +5,12 @@ Configuration for generating LUIS Authoring SDK. ``` yaml -tag: authoring_2_0 +tag: authoring_3_0_preview add-credentials: true openapi-type: data-plane ``` -The current release for the Authoring Endpoint is `authoring_2_0`. +The current release for the Authoring Endpoint is `authoring_3_0_preview`. # Releases @@ -49,6 +49,43 @@ directive: ``` --- + +## Authoring 3.0 +These settings apply only when `--tag=authoring_3_0_preview` is specified on the command line. + +``` yaml $(tag) == 'authoring_3_0_preview' +input-file: preview/v3.0/LUIS-Authoring.json +``` + +Deprecated Pattern's Operations + +``` yaml $(tag) == 'authoring_2_0' +directive: + - reason: Deprecated + remove-operation: Features_GetApplicationVersionPatternFeatures + - reason: Deprecated + remove-operation: Features_CreatePatternFeature + - reason: Deprecated + remove-operation: Features_GetPatternFeatureInfo + - reason: Deprecated + remove-operation: Features_UpdatePatternFeature + - reason: Deprecated + remove-operation: Features_DeletePatternFeature +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: DeleteMustNotHaveRequestBody + reason: Body is used to specify entity to delete + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Changing casing will break existing clients/consumers +``` + +--- + # Code Generation @@ -65,7 +102,7 @@ swagger-to-sdk: - repo: azure-sdk-for-node ``` -### Authoring 2.0 - CSharp Settings +### CSharp Settings These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: @@ -110,6 +147,7 @@ require: $(this-folder)/../../../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/stable/v2.0/LUIS-Authoring.json + - $(this-folder)/preview/v3.0/LUIS-Authoring.json ``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md index 328ac1b1405d..01f58b6c88ce 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md @@ -14,7 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: runtime_2_0 - - tag: runtime_3_0_preview + - tag: runtime_3_0 ``` ### Tag: runtime_2_0 and go @@ -26,11 +26,11 @@ Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'runtime_3_0_preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/luis/$(namespace) +``` yaml $(tag) == 'runtime_3_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/luis/$(namespace) ``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md index f3cfc53a6e6e..1c82a16cb50d 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md @@ -5,12 +5,12 @@ Configuration for generating LUIS Runtime SDK. ``` yaml -tag: runtime_3_0_preview +tag: runtime_3_0 add-credentials: true openapi-type: data-plane ``` -The current release for the Runtime Endpoint is `runtime_3_0_preview`. +The current release for the Runtime Endpoint is `runtime_3_0`. # Releases @@ -25,11 +25,11 @@ directive: remove-operation: Prediction_Resolve2 ``` -## Runtime 3.0-preview -These settings apply only when `--tag=runtime_3_0_preview` is specified on the command line. +## Runtime 3.0 +These settings apply only when `--tag=runtime_3_0` is specified on the command line. -``` yaml $(tag) == 'runtime_3_0_preview' -input-file: preview/v3.0/LUIS-Runtime.json +``` yaml $(tag) == 'runtime_3_0' +input-file: stable/v3.0/LUIS-Runtime.json # remove the GET APIs from code-generation (since the POST and GET operations are functionally identical) directive: @@ -110,7 +110,7 @@ require: $(this-folder)/../../../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/stable/v2.0/LUIS-Runtime.json - - $(this-folder)/preview/v3.0/LUIS-Runtime.json + - $(this-folder)/stable/v3.0/LUIS-Runtime.json ``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/LUIS-Runtime.json similarity index 97% rename from specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json rename to specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/LUIS-Runtime.json index 3de6b0d061a2..10ba25f03073 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/LUIS-Runtime.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/LUIS-Runtime.json @@ -2,10 +2,10 @@ "swagger": "2.0", "info": { "title": "LUIS Runtime Client", - "version": "3.0-preview" + "version": "3.0" }, "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/luis/v3.0-preview", + "hostTemplate": "{Endpoint}/luis/prediction/v3.0", "useSchemePrefix": false, "parameters": [ { @@ -335,17 +335,12 @@ "Prediction": { "description": "Represents the prediction of a query.", "required": [ - "normalizedQuery", "topIntent", "intents", "entities" ], "type": "object", "properties": { - "normalizedQuery": { - "description": "The query after pre-processing and normalization.", - "type": "string" - }, "alteredQuery": { "description": "The query after spell checking. Only set if spell check was enabled and a spelling mistake was found.", "type": "string" @@ -362,7 +357,7 @@ } }, "entities": { - "description": "The dictionary representing the entities that fired.", + "description": "A dictionary representing the entities that fired.", "type": "object", "additionalProperties": {} }, @@ -475,7 +470,7 @@ "description": "The reference DateTime used for predicting datetime entities.", "type": "string" }, - "overridePredictions": { + "preferExternalEntities": { "description": "Whether to make the external entities resolution override the predictions if an overlap occurs.", "type": "boolean" } @@ -506,6 +501,11 @@ }, "resolution": { "description": "A user supplied custom resolution to return as the entity's prediction." + }, + "score": { + "format": "float", + "description": "A user supplied score to return as the entity's prediction score.", + "type": "number" } } }, diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json similarity index 89% rename from specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json index a52047479c17..9826c6cc9b5a 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaGetRequest.json @@ -12,7 +12,6 @@ "body": { "query": "forward to frank 30 dollars through HSBC", "prediction": { - "normalizedQuery": "forward to frank 30 dollars through hsbc", "topIntent": "give", "intents": { "give": { @@ -28,7 +27,7 @@ ], "money": [ { - "unit": "Dollar", + "units": "Dollar", "value": 30 } ], diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json similarity index 93% rename from specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json index cc69253c04a0..0aade5e0b135 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetSlotPredictionsFromEndpointViaPostRequest.json @@ -39,7 +39,6 @@ "body": { "query": "forward to frank 30 dollars through HSBC", "prediction": { - "normalizedQuery": "forward to frank 30 dollars through hsbc", "topIntent": "give", "intents": { "give": { @@ -57,7 +56,7 @@ ], "money": [ { - "unit": "Dollar", + "units": "Dollar", "value": 30 } ], diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json similarity index 90% rename from specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json index 6cb97372c318..8da65ab5ab25 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaGetRequest.json @@ -12,7 +12,6 @@ "body": { "query": "forward to frank 30 dollars through HSBC", "prediction": { - "normalizedQuery": "forward to frank 30 dollars through hsbc", "topIntent": "give", "intents": { "give": { @@ -30,7 +29,7 @@ ], "money": [ { - "unit": "Dollar", + "units": "Dollar", "value": 30 } ], diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json similarity index 93% rename from specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json index 3ffa8f619d8c..dc61581182d4 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/preview/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v3.0/examples/prediction/SuccessfulGetVersionPredictionsFromEndpointViaPostRequest.json @@ -39,7 +39,6 @@ "body": { "query": "forward to frank 30 dollars through HSBC", "prediction": { - "normalizedQuery": "forward to frank 30 dollars through hsbc", "topIntent": "give", "intents": { "give": { @@ -57,7 +56,7 @@ ], "money": [ { - "unit": "Dollar", + "units": "Dollar", "value": 30 } ], diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json index 5850d1809521..ea99baedc0b5 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.0/Personalizer.json @@ -277,7 +277,7 @@ } }, "RankableAction": { - "description": "An action with it\u0027s associated features used for ranking.", + "description": "An action with it's associated features used for ranking.", "required": [ "id", "features" @@ -317,7 +317,7 @@ "readOnly": true }, "rewardActionId": { - "description": "The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the \r\nfirst found in \u0027ranking\u0027 if an action in the request in first position was part of the excluded ids.", + "description": "The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the \r\nfirst found in 'ranking' if an action in the request in first position was part of the excluded ids.", "maxLength": 256, "type": "string", "readOnly": true diff --git a/specification/cognitiveservices/data-plane/Personalizer/readme.md b/specification/cognitiveservices/data-plane/Personalizer/readme.md index c779dc0463e0..888fcc5d55a7 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/readme.md +++ b/specification/cognitiveservices/data-plane/Personalizer/readme.md @@ -1,22 +1,29 @@ # Cognitive Services Personalizer SDK -> see https://aka.ms/autorest +## Releases -Configuration for generating Personalizer SDK. +> see https://aka.ms/autorest -The current release is `release_1_0`. +The current release is `release_1_0`. A preview release release_1_0 is also available ``` yaml tag: release_1_0 add-credentials: true openapi-type: data-plane ``` -# Releases ### Release 1.0 These settings apply only when `--tag=release_1_0` is specified on the command line. ``` yaml $(tag) == 'release_1_0' +input-file: + - stable/v1.0/Personalizer.json +``` + +### Release 1.0-Preview +These settings apply only when `--tag=release_1_0_preview` is specified on the command line. + +``` yaml $(tag) == 'release_1_0_preview' input-file: - preview/v1.0/Personalizer.json ``` @@ -29,7 +36,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-ruby @@ -37,7 +43,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_personalizer'] ``` - ## CSharp Settings These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) @@ -54,11 +59,9 @@ directive: - from: source-file-csharp where: $ transform: >- - if ($.includes("class Events")) - return $ - .replace( /\"this.Endpoint\"/g, "\"this.Client.Endpoint\"" ) - .replace( /this.Endpoint/g, "Client.Endpoint" ); - return $; + return $ + .replace( /\"this.Endpoint\"/g, "\"this.Client.Endpoint\"" ) + .replace( /this.Endpoint/g, "Client.Endpoint" ); ``` ## Multi-API/Profile support for AutoRest v3 generators @@ -73,6 +76,7 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/stable/v1.0/Personalizer.json - $(this-folder)/preview/v1.0/Personalizer.json ``` @@ -84,4 +88,3 @@ uncomment the `exclude-file` section below and add the file paths. #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/Personalizer.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/Personalizer.json new file mode 100644 index 000000000000..e89aa576ea0a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/Personalizer.json @@ -0,0 +1,1257 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1.0", + "title": "Personalizer Client", + "description": "Personalizer Service is an Azure Cognitive Service that makes it easy to target content and experiences without complex pre-analysis or cleanup of past data. Given a context and featurized content, the Personalizer Service returns which content item to show to users in rewardActionId. As rewards are sent in response to the use of rewardActionId, the reinforcement learning algorithm will improve the model and improve performance of future rank calls." + }, + "basePath": "/personalizer/v1.0", + "paths": { + "/configurations/service": { + "get": { + "tags": [ + "Configurations" + ], + "summary": "Get Service Configuration.", + "description": "Get the Personalizer service configuration.", + "operationId": "ServiceConfiguration_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Get request": { + "$ref": "./examples/ServiceConfiguration_Get.json" + } + } + }, + "put": { + "tags": [ + "Configurations" + ], + "summary": "Update Service Configuration.", + "description": "Update the Personalizer service configuration.", + "operationId": "ServiceConfiguration_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "config", + "in": "body", + "description": "The personalizer service configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + }, + "default": { + "description": "Invalid service configuration.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Update request": { + "$ref": "./examples/ServiceConfiguration_Update.json" + } + } + } + }, + "/configurations/policy": { + "get": { + "tags": [ + "Configurations" + ], + "summary": "Get Policy.", + "description": "Get the Learning settings currently used by the Personalizer service.", + "operationId": "Policy_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Get request": { + "$ref": "./examples/Policy_Get.json" + } + } + }, + "put": { + "tags": [ + "Configurations" + ], + "summary": "Update Policy.", + "description": "Update the Learning settings that the Personalizer service will use to train models.", + "operationId": "Policy_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "policy", + "in": "body", + "description": "The Learning settings.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + }, + "default": { + "description": "Invalid policy configuration.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Policy_Update request": { + "$ref": "./examples/Policy_Update.json" + } + } + }, + "delete": { + "tags": [ + "Configurations" + ], + "summary": "Reset Policy.", + "description": "Resets the Learning settings of the Personalizer service to default.", + "operationId": "Policy_Reset", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Reset request": { + "$ref": "./examples/Policy_Reset.json" + } + } + } + }, + "/evaluations/{evaluationId}": { + "get": { + "tags": [ + "Evaluations" + ], + "summary": "Get Evaluation.", + "description": "Get the evaluation associated with the Id.", + "operationId": "Evaluations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "Id of the evaluation.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + } + }, + "default": { + "description": "Evaluation not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluations_Get request": { + "$ref": "./examples/Evaluations_Get.json" + } + } + }, + "delete": { + "tags": [ + "Evaluations" + ], + "summary": "Delete Evaluation.", + "description": "Delete the evaluation associated with the Id.", + "operationId": "Evaluations_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "Id of the evaluation to delete.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Evaluations_Delete request": { + "$ref": "./examples/Evaluations_Delete.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Evaluations" + ], + "summary": "List Evaluations.", + "description": "List all the submitted evaluations.", + "operationId": "Evaluations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + } + } + } + }, + "x-ms-examples": { + "Successful Evaluations_List request": { + "$ref": "./examples/Evaluations_List.json" + } + } + }, + "post": { + "tags": [ + "Evaluations" + ], + "summary": "Create Evaluation.", + "description": "Submit a new evaluation job.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluation", + "in": "body", + "description": "The evaluation job definition.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationContract" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "Location of the evaluation resource", + "type": "string" + } + } + }, + "default": { + "description": "Invalid evaluation contract.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluations_Create request": { + "$ref": "./examples/Evaluations_Create.json" + } + } + } + }, + "/events/{eventId}/reward": { + "post": { + "tags": [ + "Events" + ], + "summary": "Post Reward.", + "description": "Report reward that resulted from using the action specified in rewardActionId for the specified event.", + "operationId": "Events_Reward", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event id this reward applies to.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "reward", + "in": "body", + "description": "The reward should be a floating point number, typically between 0 and 1.", + "required": true, + "schema": { + "$ref": "#/definitions/RewardRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid reward request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Events_Reward request": { + "$ref": "./examples/Events_Reward.json" + } + } + } + }, + "/events/{eventId}/activate": { + "post": { + "tags": [ + "Events" + ], + "summary": "Activate Event.", + "description": "Report that the specified event was actually displayed to the user and a reward should be expected for it", + "operationId": "Events_Activate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event ID this activation applies to.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid activate event request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Events_Activate request": { + "$ref": "./examples/Events_Activate.json" + } + } + } + }, + "/logs": { + "delete": { + "tags": [ + "Logs" + ], + "summary": "Deletes Logs.", + "description": "Delete all generated logs.", + "operationId": "Log_Delete", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Log_Delete request": { + "$ref": "./examples/Log_Delete.json" + } + } + } + }, + "/logs/properties": { + "get": { + "tags": [ + "Logs" + ], + "summary": "Get Log Properties.", + "description": "Get properties of generated logs.", + "operationId": "Log_GetProperties", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LogsProperties" + } + }, + "default": { + "description": "Logs properties not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Log_GetProperties request": { + "$ref": "./examples/Log_GetProperties.json" + } + } + } + }, + "/model": { + "get": { + "tags": [ + "Model" + ], + "summary": "Get Model.", + "description": "Get the model file generated by Personalizer service.", + "operationId": "Model_Get", + "consumes": [], + "produces": [ + "application/octet-stream" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + } + }, + "x-ms-examples": { + "Successful Model_Get request": { + "$ref": "./examples/Model_Get.json" + } + } + }, + "delete": { + "tags": [ + "Model" + ], + "summary": "Reset Model.", + "description": "Resets the model file generated by Personalizer service.", + "operationId": "Model_Reset", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Model reset failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Model_Reset request": { + "$ref": "./examples/Model_Reset.json" + } + } + } + }, + "/model/properties": { + "get": { + "tags": [ + "Model" + ], + "summary": "Get Model Properties.", + "description": "Get properties of the model file generated by Personalizer service.", + "operationId": "Model_GetProperties", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelProperties" + } + } + }, + "x-ms-examples": { + "Successful Model_GetProperties request": { + "$ref": "./examples/Model_GetProperties.json" + } + } + } + }, + "/rank": { + "post": { + "tags": [ + "Rank" + ], + "summary": "Post Rank.", + "description": "Submit a Personalizer rank request, to get which of the provided actions should be used in the provided context.", + "operationId": "Rank", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "rankRequest", + "in": "body", + "description": "A Personalizer request.", + "required": true, + "schema": { + "$ref": "#/definitions/RankRequest" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RankResponse" + } + }, + "default": { + "description": "Invalid rank request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Rank request": { + "$ref": "./examples/Rank.json" + } + } + } + } + }, + "definitions": { + "ServiceConfiguration": { + "description": "The configuration of the service.", + "required": [ + "rewardWaitTime", + "defaultReward", + "rewardAggregation", + "explorationPercentage", + "modelExportFrequency", + "logRetentionDays" + ], + "type": "object", + "properties": { + "rewardWaitTime": { + "format": "duration", + "description": "The time span waited until a request is marked with the default reward.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string" + }, + "defaultReward": { + "format": "float", + "description": "The reward given if a reward is not received within the specified wait time.", + "maximum": 1, + "minimum": -1, + "type": "number" + }, + "rewardAggregation": { + "description": "The function used to process rewards, if multiple reward scores are received before rewardWaitTime is over.", + "maxLength": 256, + "type": "string" + }, + "explorationPercentage": { + "format": "float", + "description": "The percentage of rank responses that will use exploration.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "modelExportFrequency": { + "format": "duration", + "description": "Personalizer will start using the most updated trained model for online ranks automatically every specified time period.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string" + }, + "logMirrorEnabled": { + "description": "Flag indicates whether log mirroring is enabled.", + "type": "boolean" + }, + "logMirrorSasUri": { + "description": "Azure storage account container SAS URI for log mirroring.", + "type": "string" + }, + "logRetentionDays": { + "format": "int32", + "description": "Number of days historical logs are to be maintained. -1 implies the logs will never be deleted.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + } + } + }, + "ErrorResponse": { + "description": "Used to return an error to the client", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/PersonalizerError", + "description": "The error object." + } + } + }, + "PersonalizerError": { + "description": "The error object.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "High level error code.", + "enum": [ + "BadRequest", + "ResourceNotFound", + "InternalServerError", + "InvalidServiceConfiguration", + "InvalidPolicyConfiguration", + "InvalidPolicyContract", + "InvalidEvaluationContract", + "InvalidRewardRequest", + "InvalidEventIdToActivate", + "InvalidRankRequest", + "InvalidExportLogsRequest", + "InvalidContainer", + "FrontEndNotFound", + "EvaluationNotFound", + "LogsPropertiesNotFound", + "RankNullResponse", + "UpdateConfigurationFailed", + "ModelResetFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "PersonalizerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "BadRequest", + "description": "Request could not be understood by the server." + }, + { + "value": "ResourceNotFound", + "description": "Requested resource does not exist on the server." + }, + { + "value": "InternalServerError", + "description": "A generic error has occurred on the server." + }, + { + "value": "InvalidServiceConfiguration", + "description": "Invalid service configuration." + }, + { + "value": "InvalidPolicyConfiguration", + "description": "Invalid policy configuration." + }, + { + "value": "InvalidPolicyContract", + "description": "Invalid policy contract." + }, + { + "value": "InvalidEvaluationContract", + "description": "Invalid evaluation contract." + }, + { + "value": "InvalidRewardRequest", + "description": "Invalid reward request." + }, + { + "value": "InvalidEventIdToActivate", + "description": "Invalid activate event request." + }, + { + "value": "InvalidRankRequest", + "description": "Invalid rank request." + }, + { + "value": "InvalidExportLogsRequest", + "description": "Invalid export logs request." + }, + { + "value": "InvalidContainer", + "description": "SAS Uri must be the Uri to a container that has write permissions." + }, + { + "value": "FrontEndNotFound", + "description": "Front end not found." + }, + { + "value": "EvaluationNotFound", + "description": "Evaluation not found." + }, + { + "value": "LogsPropertiesNotFound", + "description": "Logs properties not found." + }, + { + "value": "RankNullResponse", + "description": "Rank call returned null response." + }, + { + "value": "UpdateConfigurationFailed", + "description": "Failed to update configuration." + }, + { + "value": "ModelResetFailed", + "description": "Model reset failed." + } + ] + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + }, + "target": { + "description": "Error source element.", + "type": "string" + }, + "details": { + "description": "An array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/PersonalizerError" + } + }, + "innerError": { + "$ref": "#/definitions/InternalError", + "description": "Finer error details." + } + } + }, + "InternalError": { + "description": "An object containing more specific information than the parent object about the error.", + "type": "object", + "properties": { + "code": { + "description": "Detailed error code.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InternalError", + "description": "The error object." + } + } + }, + "PolicyContract": { + "description": "Learning settings specifying how to train the model.", + "required": [ + "name", + "arguments" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the Learning settings.", + "maxLength": 256, + "type": "string" + }, + "arguments": { + "description": "Arguments of the Learning settings.", + "maxLength": 1024, + "type": "string" + } + } + }, + "Evaluation": { + "type": "object", + "properties": { + "id": { + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "name": { + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "jobId": { + "type": "string", + "readOnly": true + }, + "status": { + "enum": [ + "completed", + "pending", + "failed", + "notSubmitted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EvaluationJobStatus", + "modelAsString": true + } + }, + "policyResults": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResult" + } + }, + "featureImportance": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PolicyResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "arguments": { + "type": "string", + "readOnly": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResultSummary" + }, + "readOnly": true + }, + "totalSummary": { + "allOf": [ + { + "$ref": "#/definitions/PolicyResultSummary" + } + ], + "readOnly": true + } + } + }, + "PolicyResultSummary": { + "type": "object", + "properties": { + "timeStamp": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "ipsEstimatorNumerator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "ipsEstimatorDenominator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "snipsEstimatorDenominator": { + "format": "float", + "type": "number", + "readOnly": true + }, + "aggregateTimeWindow": { + "format": "duration", + "type": "string", + "readOnly": true + }, + "nonZeroProbability": { + "format": "float", + "type": "number" + }, + "confidenceInterval": { + "format": "float", + "type": "number", + "readOnly": true + }, + "sumOfSquares": { + "format": "float", + "type": "number", + "readOnly": true + } + } + }, + "EvaluationContract": { + "description": "A counterfactual evaluation.", + "required": [ + "name", + "startTime", + "endTime", + "policies" + ], + "type": "object", + "properties": { + "enableOfflineExperimentation": { + "description": "True if the evaluation should explore for a more optimal Learning settings.", + "type": "boolean" + }, + "name": { + "description": "The name of the evaluation.", + "maxLength": 256, + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the evaluation.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the evaluation.", + "type": "string" + }, + "policies": { + "description": "Additional Learning settings to evaluate.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyContract" + } + } + } + }, + "RewardRequest": { + "description": "Reward given to a rank response.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "format": "float", + "description": "Reward to be assigned to an action. Value should be between -1 and 1 inclusive.", + "type": "number" + } + } + }, + "LogsProperties": { + "type": "object", + "properties": { + "dateRange": { + "allOf": [ + { + "$ref": "#/definitions/DateRange" + } + ], + "readOnly": true + } + } + }, + "DateRange": { + "type": "object", + "properties": { + "from": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "to": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "ModelProperties": { + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedTime": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "RankRequest": { + "description": "Request a set of actions to be ranked by the Personalizer service.", + "required": [ + "actions" + ], + "type": "object", + "properties": { + "contextFeatures": { + "description": "Features of the context used for Personalizer as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, aggregated data about time and date, etc.\r\nFeatures should not include personally identifiable information (PII),\r\nunique UserIDs, or precise timestamps.", + "type": "array", + "items": { + "type": "object" + } + }, + "actions": { + "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.\r\nThe first item in the array will be used as Baseline item in Offline evaluations.", + "type": "array", + "items": { + "$ref": "#/definitions/RankableAction" + } + }, + "excludedActions": { + "description": "The set of action ids to exclude from ranking.", + "type": "array", + "items": { + "type": "string" + } + }, + "eventId": { + "description": "Optionally pass an eventId that uniquely identifies this Rank event.\r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a Personalizer call.", + "maxLength": 256, + "type": "string" + }, + "deferActivation": { + "description": "Send false if it is certain the rewardActionId in rank results will be shown to the user, therefore\r\nPersonalizer will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\naction specified in the rank results, because the page is rendering later, or the Rank results may be\r\noverridden by code further downstream.", + "default": false, + "type": "boolean" + } + } + }, + "RankableAction": { + "description": "An action with it's associated features used for ranking.", + "required": [ + "id", + "features" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the action.", + "maxLength": 256, + "type": "string" + }, + "features": { + "description": "List of dictionaries containing features.", + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "RankResponse": { + "description": "Returns which action to use as rewardActionId, and additional information about each action as a result of a Rank request.", + "type": "object", + "properties": { + "ranking": { + "description": "The calculated ranking for the current request.", + "type": "array", + "items": { + "$ref": "#/definitions/RankedAction" + }, + "readOnly": true + }, + "eventId": { + "description": "The eventId for the round trip from request to response.", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "rewardActionId": { + "description": "The action chosen by the Personalizer service. This is the action your application should display, and for which to report the reward. This might not be the\r\nfirst found in 'ranking' if an action in the request in first position was part of the excluded ids.", + "maxLength": 256, + "type": "string", + "readOnly": true + } + } + }, + "RankedAction": { + "description": "A ranked action with its resulting probability.", + "type": "object", + "properties": { + "id": { + "description": "Id of the action", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "probability": { + "format": "float", + "description": "Probability of the action", + "maximum": 1, + "minimum": 0, + "type": "number", + "readOnly": true + } + } + }, + "ContainerStatus": { + "type": "object", + "properties": { + "service": { + "type": "string" + }, + "apiStatus": { + "type": "string" + }, + "apiStatusMessage": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "apim_key": { + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "type": "apiKey" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "tags": [ + { + "name": "Configurations", + "description": "Manages configuration operations." + }, + { + "name": "Evaluations", + "description": "Manages counterfactual evaluation operations." + }, + { + "name": "Events", + "description": "Manages event operations." + }, + { + "name": "Logs", + "description": "Manages reinforcement learning logs." + }, + { + "name": "Model", + "description": "Manages reinforcement learning configuration operations." + }, + { + "name": "Rank", + "description": "Manages ranking operations." + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Create.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Create.json new file mode 100644 index 000000000000..8e392dfae1cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Create.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluation": { + "enableOfflineExperimentation": true, + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "policies": [ + { + "name": "Custom Learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ] + }, + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/personalizer/v1.0/evaluations/{evaluationId}" + }, + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "pending", + "policyResults": [ + { + "name": "Custom Learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ], + "featureImportance": [] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Delete.json new file mode 100644 index 000000000000..682e8a6a8084 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluationId": "id", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Get.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Get.json new file mode 100644 index 000000000000..aec174af7856 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "evaluationId": "id", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "completed", + "policyResults": [ + { + "name": "Custom Learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5", + "summary": [ + { + "timeStamp": "2018-12-19T00:00:00Z", + "ipsEstimatorNumerator": 0.0, + "ipsEstimatorDenominator": 170.0, + "snipsEstimatorDenominator": 308.25, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 64.0, + "confidenceInterval": 0.0, + "sumOfSquares": 0.0 + }, + { + "timeStamp": "2018-12-19T00:05:00Z", + "ipsEstimatorNumerator": 2.2, + "ipsEstimatorDenominator": 196.0, + "snipsEstimatorDenominator": 193.761, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 68.0, + "confidenceInterval": 1.1009, + "sumOfSquares": 2.424 + } + ], + "totalSummary": { + "timeStamp": "2019-01-19T00:00:00Z", + "ipsEstimatorNumerator": 22.2, + "ipsEstimatorDenominator": 1906.0, + "snipsEstimatorDenominator": 1993.761, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 68.0, + "confidenceInterval": 1.1209, + "sumOfSquares": 2.484 + } + } + ], + "featureImportance": [ + [ + "f1", + "f2" + ], + [ + "f3", + "f4" + ] + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_List.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_List.json new file mode 100644 index 000000000000..c09af2b83e0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Evaluations_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-11-19T00:00:00Z", + "endTime": "2018-12-19T00:00:00Z", + "status": "pending", + "policyResults": [ + { + "name": "Custom Learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ], + "featureImportance": [] + }, + { + "id": "21d03972-9130-4be9-8c8b-8ac3ec9b9dd1", + "name": "mySecondEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "pending", + "policyResults": [], + "featureImportance": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Activate.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Activate.json new file mode 100644 index 000000000000..a7bec92839a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Activate.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "eventId": "id", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Reward.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Reward.json new file mode 100644 index 000000000000..78802cdfed80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Events_Reward.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "eventId": "id", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "reward": { + "value": 1.0 + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_Delete.json new file mode 100644 index 000000000000..bd50cf1be127 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_GetProperties.json new file mode 100644 index 000000000000..fc02b29ae13b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Log_GetProperties.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "dateRange": { + "from": "2019-01-18T16:00:00-08:00", + "to": "2019-02-18T16:00:00-08:00" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Get.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Get.json new file mode 100644 index 000000000000..b8aee663b45a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Get.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_GetProperties.json new file mode 100644 index 000000000000..df3753d4749b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_GetProperties.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "creationTime": "2019-01-18T16:00:00-08:00", + "lastModifiedTime": "2019-01-18T16:00:00-08:00" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Reset.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Reset.json new file mode 100644 index 000000000000..bd50cf1be127 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Model_Reset.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Get.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Get.json new file mode 100644 index 000000000000..d454ebf852e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Reset.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Reset.json new file mode 100644 index 000000000000..d454ebf852e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Reset.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Update.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Update.json new file mode 100644 index 000000000000..a20c1b928b74 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Policy_Update.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "policy": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Rank.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Rank.json new file mode 100644 index 000000000000..32772be66a8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/Rank.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "rankRequest": { + "contextFeatures": [ + { + "timeOfDay": "Morning" + } + ], + "actions": [ + { + "id": "NewsArticle", + "features": [ + { + "type": "News" + } + ] + }, + { + "id": "SportsArticle", + "features": [ + { + "type": "Sports" + } + ] + }, + { + "id": "EntertainmentArticle", + "features": [ + { + "type": "Entertainment" + } + ] + } + ], + "excludedActions": [ + "SportsArticle" + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "deferActivation": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "ranking": [ + { + "id": "EntertainmentArticle", + "probability": 0.8 + }, + { + "id": "SportsArticle", + "probability": 0.0 + }, + { + "id": "NewsArticle", + "probability": 0.2 + } + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "rewardActionId": "EntertainmentArticle" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Get.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Get.json new file mode 100644 index 000000000000..6c1ba6b0d7b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "rewardWaitTime": "PT10M", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Update.json b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Update.json new file mode 100644 index 000000000000..60eee8d630cb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/stable/v1.0/examples/ServiceConfiguration_Update.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "config": { + "rewardWaitTime": "PT10M", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7 + }, + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "rewardWaitTime": "PT10M", + "defaultReward": 0.0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index 1e2608898e8c..928efa6d8bd0 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -627,6 +627,16 @@ "$ref": "#/definitions/UpdateKbContentsDTO" } ] + }, + "enableHierarchicalExtraction": { + "type": "boolean", + "description": "Enable hierarchical extraction of Q-A from files and urls. The value set during KB creation will be used if this field is not present." + }, + "defaultAnswerUsedForExtraction": { + "type": "string", + "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.", + "maxLength": 300, + "minLength": 1 } } }, @@ -879,6 +889,22 @@ "items": { "$ref": "#/definitions/FileDTO" } + }, + "enableHierarchicalExtraction": { + "type": "boolean", + "description": "Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present." + }, + "defaultAnswerUsedForExtraction":{ + "type": "string", + "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.", + "maxLength": 300, + "minLength": 1 + }, + "language": { + "type": "string", + "description": "Language of the knowledgebase.", + "maxLength": 100, + "minLength": 1 } } }, @@ -1324,6 +1350,10 @@ "lastStableVersion": { "type": "string", "description": "Latest version of runtime." + }, + "language": { + "type": "string", + "description": "Language setting of runtime." } } } diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json index adc3dd313096..5011550648dc 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json @@ -357,6 +357,10 @@ } ] }, + "rankerType": { + "type": "string", + "description": "Optional field. Set to 'QuestionOnly' for using a question only Ranker." + }, "strictFilters": { "type": "array", "description": "Find only answers that contain these metadata.", diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json new file mode 100644 index 000000000000..2c826b9ba1c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json @@ -0,0 +1,1122 @@ +{ + "swagger": "2.0", + "info": { + "version": "v3.0-preview.1", + "contact": { + "name": "Microsoft Cognitive Services", + "url": "https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/", + "email": "mlapi@microsoft.com" + }, + "title": "Text Analytics Client", + "description": "The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/text/analytics/v3.0-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "paths": { + "/entities/recognition/general": { + "post": { + "summary": "Named Entity Recognition", + "description": "The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesRecognitionGeneral", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "required": false, + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean", + "required": false + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities returned for each valid document.", + "schema": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Entities request": { + "$ref": ".//examples//SuccessfulEntitiesRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/recognition/pii": { + "post": { + "summary": "Entities containing personal information", + "description": "The API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in the document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.\n", + "operationId": "EntitiesRecognitionPii", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean" + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of entities containing personal information returned for each valid document", + "schema": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Entity PII request": { + "$ref": ".//examples//SuccessfulEntityPIIRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/linking": { + "post": { + "summary": "Linked entities from a well-known knowledge base", + "description": "The API returns a list of recognized entities with links to a well-known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesLinking", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean" + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities with links to a well-known knowledge base returned for each valid document", + "schema": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Entity Linking request": { + "$ref": ".//examples//SuccessfulEntityLinkingRequest.json" + } + }, + "deprecated": false + } + }, + "/keyPhrases": { + "post": { + "summary": "Key Phrases", + "description": "The API returns a list of strings denoting the key phrases in the input text. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "KeyPhrases", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean" + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze. Documents can now contain a language field to indicate the text language", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful response results in 0 or more key phrases identified in each valid document", + "schema": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Key Phrase request": { + "$ref": ".//examples//SuccessfulKeyPhrasesRequest.json" + } + }, + "deprecated": false + } + }, + "/languages": { + "post": { + "summary": "Detect Language", + "description": "The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "Languages", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean" + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/LanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in the detected language with the highest probability for each valid document", + "schema": { + "$ref": "#/definitions/LanguageResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Detect Language request": { + "$ref": ".//examples//SuccessfulLanguagesRequest.json" + } + }, + "deprecated": false + } + }, + "/sentiment": { + "post": { + "summary": "Sentiment", + "description": "The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "Sentiment", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain input and document level statistics.", + "type": "boolean" + }, + { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in a document sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral)", + "schema": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "x-ms-examples": { + "Successful Sentiment request": { + "$ref": ".//examples//SuccessfulSentimentRequest.json" + } + }, + "deprecated": false + } + } + }, + "definitions": { + "MultiLanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "description": "The set of documents to process as part of this batch.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + }, + "description": "Contains a set of input documents to be analyzed by the service." + }, + "MultiLanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + } + }, + "description": "Contains an input document to be analyzed by the service." + }, + "DocumentError": { + "type": "object", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "Document Id." + }, + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "TextAnalyticsError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "invalidRequest", + "invalidArgument", + "internalServerError", + "serviceUnavailable" + ], + "x-ms-enum": { + "name": "ErrorCodeValue", + "modelAsString": false + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + }, + "details": { + "type": "array", + "description": "Details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + } + }, + "InnerError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "invalidParameterValue", + "invalidRequestBodyFormat", + "emptyRequest", + "missingInputRecords", + "invalidDocument", + "modelVersionIncorrect", + "invalidDocumentBatch", + "unsupportedLanguageCode", + "invalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCodeValue", + "modelAsString": false + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + } + } + }, + "SentimentResponse": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "$ref": "#/definitions/DocumentSentiment" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentSentiment": { + "type": "object", + "required": [ + "id", + "sentiment", + "documentScores", + "sentences" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics" + }, + "documentScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + } + } + }, + "RequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "DocumentStatistics": { + "type": "object", + "required": [ + "charactersCount", + "transactionsCount" + ], + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "SentimentConfidenceScorePerLabel": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "neutral": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "SentenceSentiment": { + "type": "object", + "required": [ + "sentiment", + "sentenceScores", + "offset", + "length" + ], + "properties": { + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "sentenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence by Unicode standard." + }, + "warnings": { + "type": "array", + "description": "The warnings generated for the sentence.", + "items": { + "type": "string" + } + } + } + }, + "EntitiesResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentEntities": { + "type": "object", + "required": [ + "id", + "entities" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "Entity": { + "type": "object", + "required": [ + "text", + "type", + "offset", + "length", + "score" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "type": { + "type": "string", + "description": "Entity type, such as Person/Location/Org/SSN etc" + }, + "subtype": { + "type": "string", + "description": "Entity sub type, such as Age/Year/TimeRange etc" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position (in Unicode characters) for the entity text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length (in Unicode characters) for the entity text." + }, + "score": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "EntityLinkingResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLinkedEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLinkedEntities": { + "type": "object", + "required": [ + "id", + "entities" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized well-known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "LinkedEntity": { + "type": "object", + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ], + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + } + } + }, + "Match": { + "type": "object", + "required": [ + "score", + "text", + "offset", + "length" + ], + "properties": { + "score": { + "type": "number", + "format": "double", + "description": "If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position (in Unicode characters) for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length (in Unicode characters) for the entity match text." + } + } + }, + "KeyPhraseResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentKeyPhrases" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentKeyPhrases": { + "type": "object", + "required": [ + "id", + "keyPhrases" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "LanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "LanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "text": { + "type": "string" + }, + "countryHint": { + "type": "string" + } + } + }, + "LanguageResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLanguage" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLanguage": { + "type": "object", + "required": [ + "id", + "detectedLanguages" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "detectedLanguages": { + "type": "array", + "description": "A list of extracted languages.", + "items": { + "$ref": "#/definitions/DetectedLanguage" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "DetectedLanguage": { + "type": "object", + "required": [ + "name", + "iso6391Name", + "score" + ], + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "score": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntitiesRequest.json new file mode 100644 index 000000000000..babd6e22d296 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntitiesRequest.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "language": "en", + "id": "2", + "text": "I work at Microsoft." + }, + { + "language": "en", + "id": "3", + "text": "I visited Space Needle 2 times." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "entities": [ + { + "text": "Seattle", + "type": "Location", + "offset": 26, + "length": 7, + "score": 0.8062429428100586 + }, + { + "text": "last week", + "type": "DateTime", + "subtype": "DateRange", + "offset": 34, + "length": 9, + "score": 0.8 + } + ] + }, + { + "id": "2", + "entities": [ + { + "text": "Microsoft", + "type": "Organization", + "offset": 10, + "length": 9, + "score": 0.9998359680175781 + } + ] + }, + { + "id": "3", + "entities": [ + { + "text": "Space Needle", + "type": "Organization", + "offset": 10, + "length": 12, + "score": 0.7599651217460632 + }, + { + "text": "2", + "type": "Quantity", + "subtype": "Number", + "offset": 23, + "length": 1, + "score": 0.8 + } + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..c58af39167b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "language": "en", + "id": "2", + "text": "I work at Microsoft." + }, + { + "language": "en", + "id": "3", + "text": "I visited Space Needle 2 times." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "entities": [ + { + "name": "Seattle", + "matches": [ + { + "text": "Seattle", + "offset": 26, + "length": 7, + "score": 0.15046201222847677 + } + ], + "language": "en", + "id": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle", + "dataSource": "Wikipedia" + } + ] + }, + { + "id": "2", + "entities": [ + { + "name": "Microsoft", + "matches": [ + { + "text": "Microsoft", + "offset": 10, + "length": 9, + "score": 0.1869365971673207 + } + ], + "language": "en", + "id": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft", + "dataSource": "Wikipedia" + } + ] + }, + { + "id": "3", + "entities": [ + { + "name": "Space Needle", + "matches": [ + { + "text": "Space Needle", + "offset": 10, + "length": 12, + "score": 0.155903620065595 + } + ], + "language": "en", + "id": "Space Needle", + "url": "https://en.wikipedia.org/wiki/Space_Needle", + "dataSource": "Wikipedia" + } + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityPIIRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityPIIRequest.json new file mode 100644 index 000000000000..29cba30d10b6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulEntityPIIRequest.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "0", + "text": "Microsoft employee with ssn 859-98-0987 is using our awesome API's." + }, + { + "language": "en", + "id": "1", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "language": "en", + "id": "2", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "0", + "entities": [ + { + "text": "859-98-0987", + "type": "U.S. Social Security Number (SSN)", + "subtype": "", + "offset": 28, + "length": 11, + "score": 0.65 + } + ] + }, + { + "id": "1", + "entities": [ + { + "text": "111000025", + "type": "ABA Routing Number", + "subtype": "", + "offset": 18, + "length": 9, + "score": 0.75 + } + ] + }, + { + "id": "2", + "entities": [ + { + "text": "998.214.865-68", + "type": "Brazil CPF Number", + "subtype": "", + "offset": 3, + "length": 14, + "score": 0.85 + } + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulKeyPhrasesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulKeyPhrasesRequest.json new file mode 100644 index 000000000000..4a61dd56c123 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulKeyPhrasesRequest.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "Hello world. This is some input text that I love." + }, + { + "language": "fr", + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "language": "es", + "id": "3", + "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "world", + "input text" + ] + }, + { + "id": "2", + "keyPhrases": [ + "monde" + ] + }, + { + "id": "3", + "keyPhrases": [ + "carretera", + "tráfico", + "día" + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulLanguagesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulLanguagesRequest.json new file mode 100644 index 000000000000..071bf51ea8c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulLanguagesRequest.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "countryHint": "US", + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "detectedLanguages": [ + { + "name": "English", + "iso6391Name": "en", + "score": 1 + } + ] + }, + { + "id": "2", + "detectedLanguages": [ + { + "name": "French", + "iso6391Name": "fr", + "score": 1 + } + ] + }, + { + "id": "3", + "detectedLanguages": [ + { + "name": "Spanish", + "iso6391Name": "es", + "score": 1 + } + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json new file mode 100644 index 000000000000..a61d236644d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "Hello world. This is some input text that I love." + }, + { + "language": "en", + "id": "2", + "text": "It's incredibly sunny outside! I'm so happy." + }, + { + "language": "en", + "id": "3", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "sentiment": "positive", + "documentScores": { + "positive": 0.998519241809845, + "neutral": 0.0009635657188483, + "negative": 0.000517153472174 + }, + "sentences": [ + { + "sentiment": "neutral", + "sentenceScores": { + "positive": 0.070910170674324, + "neutral": 0.9124033451080322, + "negative": 0.0166865326464176 + }, + "offset": 0, + "length": 12 + }, + { + "sentiment": "positive", + "sentenceScores": { + "positive": 0.998519241809845, + "neutral": 0.0009635657188483, + "negative": 0.000517153472174 + }, + "offset": 13, + "length": 36 + } + ] + }, + { + "id": "2", + "sentiment": "positive", + "documentScores": { + "positive": 0.9954571723937988, + "neutral": 0.0034653299953789, + "negative": 0.0010774657130241 + }, + "sentences": [ + { + "sentiment": "neutral", + "sentenceScores": { + "positive": 0.0499138832092285, + "neutral": 0.9387012720108032, + "negative": 0.0113849258050323 + }, + "offset": 0, + "length": 30 + }, + { + "sentiment": "positive", + "sentenceScores": { + "positive": 0.9954571723937988, + "neutral": 0.0034653299953789, + "negative": 0.0010774657130241 + }, + "offset": 31, + "length": 13 + } + ] + }, + { + "id": "3", + "sentiment": "positive", + "documentScores": { + "positive": 0.9965128302574158, + "neutral": 0.0018965365597978, + "negative": 0.0015906029148027 + }, + "sentences": [ + { + "sentiment": "positive", + "sentenceScores": { + "positive": 0.9965128302574158, + "neutral": 0.0018965365597978, + "negative": 0.0015906029148027 + }, + "offset": 0, + "length": 52 + } + ] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 60e5b6ad8d9d..aaa4fc2829e7 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -149,6 +149,15 @@ input-file: preview/v2.1/TextAnalytics.json log-file: logs/log.txt ``` +### Release 3.0-Preview.1 + +These settings apply only when `--tag=release_3_0_preview.1` is specified on the command line. + +``` yaml $(tag) == 'release_3_0_preview.1' +input-file: preview/v3.0-preview.1/TextAnalytics.json +log-file: logs/log.txt +``` + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -244,6 +253,7 @@ input-file: - $(this-folder)/stable/v2.0/TextAnalytics.json - $(this-folder)/stable/v2.1/TextAnalytics.json - $(this-folder)/preview/v2.1/TextAnalytics.json + - $(this-folder)/preview/v3.0-preview.1/TextAnalytics.json ``` diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.1/TextAnalytics.json index d54e2f91d6ca..f2986728bd65 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.1/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.1/TextAnalytics.json @@ -229,7 +229,7 @@ "$ref": "#/definitions/SentimentBatchResult" } }, - "500": { + "default": { "description": "Error Response", "schema": { "$ref": "#/definitions/ErrorResponse" @@ -259,25 +259,6 @@ "$ref": "#/definitions/MultiLanguageInput" } } - }, - "example": { - "documents": [ - { - "language": "en", - "id": "1", - "text": "Hello world. This is some input text that I love." - }, - { - "language": "fr", - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "language": "es", - "id": "3", - "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer." - } - ] } }, "MultiLanguageInput": { @@ -557,25 +538,6 @@ "$ref": "#/definitions/LanguageInput" } } - }, - "example": { - "documents": [ - { - "countryHint": "en", - "id": "1", - "text": "Hello world. This is some input text that I love." - }, - { - "countryHint": "fr", - "id": "2", - "text": "Bonjour tout le monde" - }, - { - "countryHint": "es", - "id": "3", - "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer." - } - ] } }, "LanguageInput": { diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json index 43fd4a58d169..c916063a70e5 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Visual Search Client", - "description": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).", + "description": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview). **NOTE:** To comply with the new EU Copyright Directive in France, the Bing Visual Search API must omit some content from certain EU News sources for French users. The removed content may include thumbnail images and videos, video previews, and snippets which accompany search results from these sources. As a consequence, the Bing APIs may serve fewer results with thumbnail images and videos, video previews, and snippets to French users.", "version": "1.0" }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json index ee56d96d053c..443a25e6d143 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json @@ -14,7 +14,7 @@ "tags": [ { "image": { - "thumbnailUrl": "https:\/\/tse4.mm.bing.net\/th?q=Space+Needle&pid=Api&mkt=en-US&adlt=moderate" + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Space+Needle&pid=Api&mkt=en-US&adlt=moderate" }, "displayName": "Space Needle", "boundingBox": { @@ -60,13 +60,13 @@ "_type": "ImageAction", "actionType": "ImageById", "image": { - "webSearchUrl": "https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO", + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO", "name": "", - "contentUrl": "https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", - "hostPageUrl": "https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", + "contentUrl": "https://assets0.roadtrippers.com/uploads/poi_gallery_image/image/319703805/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", + "hostPageUrl": "https://assets0.roadtrippers.com/uploads/poi_gallery_image/image/319703805/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", "contentSize": "47157 B", "encodingFormat": "jpeg", - "hostPageDisplayUrl": "https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", + "hostPageDisplayUrl": "https://assets0.roadtrippers.com/uploads/poi_gallery_image/image/319703805/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg", "width": 1024, "height": 480, "thumbnail": { @@ -80,7 +80,7 @@ }, { "image": { - "thumbnailUrl": "https:\/\/tse4.mm.bing.net\/th?q=city&pid=Api&mkt=en-US&adlt=moderate" + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=city&pid=Api&mkt=en-US&adlt=moderate" }, "displayName": "city", "boundingBox": { @@ -124,9 +124,9 @@ "actions": [ { "_type": "ImageAction", - "webSearchUrl": "https:\/\/www.bing.com\/images\/search?q=city", + "webSearchUrl": "https://www.bing.com/images/search?q=city", "displayName": "city", - "serviceUrl": "https:\/\/www.bing.com\/api\/v7\/images\/search?q=city", + "serviceUrl": "https://www.bing.com/api/v7/images/search?q=city", "actionType": "ImageResults" } ] diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json index 8dce807da01d..a0d747af107d 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json @@ -58,11 +58,11 @@ "description": "The name of Cognitive Services account." }, { - "name": "parameters", + "name": "account", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CognitiveServicesAccountCreateParameters" + "$ref": "#/definitions/CognitiveServicesAccount" }, "description": "The parameters to provide for the created account." }, @@ -86,6 +86,12 @@ "$ref": "#/definitions/CognitiveServicesAccount" } }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccount" + } + }, "default": { "description": "Error response describing why the operation failed", "schema": { @@ -124,12 +130,11 @@ "description": "The name of Cognitive Services account." }, { - "name": "parameters", + "name": "account", "in": "body", "required": true, - "x-ms-client-flatten": true, "schema": { - "$ref": "#/definitions/CognitiveServicesAccountUpdateParameters" + "$ref": "#/definitions/CognitiveServicesAccount" }, "description": "The parameters to provide for the created account." }, @@ -147,6 +152,12 @@ "$ref": "#/definitions/CognitiveServicesAccount" } }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CognitiveServicesAccount" + } + }, "default": { "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", "schema": { @@ -195,6 +206,9 @@ "200": { "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, "204": { "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." }, @@ -638,7 +652,7 @@ "tags": [ "CognitiveServicesAccounts" ], - "operationId": "CheckSkuAvailability_List", + "operationId": "CheckSkuAvailability", "description": "Check available SKUs.", "x-ms-examples": { "Check SKU Availability": { @@ -718,64 +732,10 @@ } }, "definitions": { - "CognitiveServicesAccountCreateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Required. Gets or sets the SKU of the resource." - }, - "kind": { - "$ref": "#/definitions/CognitiveServicesAccountKind", - "description": "Required. Gets or sets the Kind of the resource." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." - }, - "properties": { - "type": "object", - "description": "Must exist in the request. Must be an empty object. Must not be null." - } - }, - "required": [ - "sku", - "kind", - "location", - "properties" - ], - "description": "The parameters to provide for the account." - }, "CognitiveServicesAccountKind": { "type": "string", "description": "Required. Indicates the type of cognitive service account." }, - "CognitiveServicesAccountUpdateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." - }, - "properties": { - "type": "object", - "description": "Additional properties for Account. Only provided fields will be updated." - } - }, - "description": "The parameters to provide for the account." - }, "Sku": { "properties": { "name": { @@ -812,7 +772,8 @@ "properties": { "etag": { "type": "string", - "description": "Entity Tag" + "description": "Entity Tag", + "readOnly": true }, "id": { "type": "string", @@ -820,8 +781,8 @@ "readOnly": true }, "kind": { - "type": "string", - "description": "Type of cognitive service account." + "$ref": "#/definitions/CognitiveServicesAccountKind", + "description": "The Kind of the resource." }, "location": { "type": "string", @@ -833,7 +794,6 @@ "readOnly": true }, "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/CognitiveServicesAccountProperties", "description": "Properties of Cognitive Services account." }, @@ -894,11 +854,13 @@ }, "endpoint": { "type": "string", - "description": "Endpoint of the created account." + "description": "Endpoint of the created account.", + "readOnly": true }, "internalId": { "type": "string", - "description": "The internal identifier." + "description": "The internal identifier.", + "readOnly": true }, "customSubDomainName": { "type": "string", @@ -907,10 +869,39 @@ "networkAcls": { "$ref": "#/definitions/NetworkRuleSet", "description": "A collection of rules governing the accessibility from specific network locations." + }, + "apiProperties": { + "$ref": "#/definitions/CognitiveServicesAccountApiProperties", + "description": "The api properties for special APIs." } }, "description": "Properties of Cognitive Services account." }, + "CognitiveServicesAccountApiProperties": { + "properties": { + "qnaRuntimeEndpoint": { + "type": "string", + "description": "(QnAMaker Only) The runtime endpoint of QnAMaker." + }, + "statisticsEnabled": { + "type": "boolean", + "description": "(Bing Search Only) The flag to enable statistics of Bing Search." + }, + "eventHubConnectionString": { + "type": "string", + "description": "(Personalization Only) The flag to enable statistics of Bing Search.", + "pattern": "^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$", + "maxLength": 1000 + }, + "storageAccountConnectionString": { + "type": "string", + "description": "(Personalization Only) The storage account connection string.", + "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$", + "maxLength": 1000 + } + }, + "description": "The api properties for special APIs." + }, "CognitiveServicesAccountKeys": { "properties": { "key1": { @@ -1383,18 +1374,6 @@ }, "NetworkRuleSet": { "properties": { - "bypass": { - "type": "string", - "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", - "enum": [ - "AzureServices", - "None" - ], - "x-ms-enum": { - "name": "NetworkRuleBypassOptions", - "modelAsString": true - } - }, "defaultAction": { "type": "string", "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CreateAccount.json index a03d569cebb0..89c1b013bdd2 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CreateAccount.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CreateAccount.json @@ -4,7 +4,7 @@ "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", "resourceGroupName": "felixwa-01", "accountName": "testCreate1", - "parameters": { + "account": { "location": "West US", "kind": "Emotion", "sku": { @@ -49,6 +49,24 @@ "internalId": "9dc1c5b9bb95486aa63899acdaebd9a0" } } + }, + "202": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "internalId": "9dc1c5b9bb95486aa63899acdaebd9a0" + } + } } } } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeleteAccount.json index ca8c96fbff78..cd0244d1544b 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeleteAccount.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/DeleteAccount.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/UpdateAccount.json index 85ccd6e423c5..e4ba6c016f26 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/UpdateAccount.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/UpdateAccount.json @@ -4,7 +4,7 @@ "subscriptionId": "f9b96b36-1f5e-4021-8959-51527e26e6d3", "resourceGroupName": "bvttest", "accountName": "bingSearch", - "parameters": { + "account": { "sku": { "name": "S2" } @@ -28,6 +28,24 @@ "internalId": "ceebe1e8e40f44e69554c1a759de4cf9" } } + }, + "202": { + "body": { + "id": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded", + "internalId": "ceebe1e8e40f44e69554c1a759de4cf9" + } + } } } } diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 7751e5797cdf..5e1afb8546f0 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -121,7 +121,7 @@ Please also specify `--azure-libraries-for-java-folder=
Minimum api-version: 2018-04-01." } }, "description": "Describes the properties of a Virtual Machine Scale Set." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json index 12fdbbabc24a..29bb119ff690 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json @@ -1,40 +1,79 @@ { "parameters": { "subscriptionId": "{subscriptionId}", - "api-version": "2018-04-01" + "api-version": "2018-04-01", + "$expand": "virtualMachines\\$ref" }, "responses": { "200": { "body": { "value": [ { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", "properties": { "platformUpdateDomainCount": 5, - "platformFaultDomainCount": 2 + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "centralus", - "tags": { - "{tagName}": "{tagValue}" + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", "sku": { - "name": "Aligned" + "name": "Classic" } }, { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, "properties": { - "platformUpdateDomainCount": 3, - "platformFaultDomainCount": 2 + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "westus", + "location": "westcentralus", "tags": { "{tagName}": "{tagValue}" }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, "sku": { "name": "Classic" } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json index 43cfc334537e..2dbb2aa4b669 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json @@ -19,12 +19,12 @@ { "name": "arg1", "type": "string", - "value": "value1" + "defaultValue": "value1" }, { "name": "arg2", "type": "string", - "value": "value2" + "defaultValue": "value2" } ], "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json index 49d1d30d8f14..6c7b4fa34bac 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json @@ -9,70 +9,70 @@ "body": { "value": [ { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableRemotePS", "osType": "Windows", "label": "Enable remote PowerShell", "description": "Configure the machine to enable remote PowerShell." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "IPConfig", "osType": "Windows", "label": "List IP configuration", "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunPowerShellScript", "osType": "Windows", "label": "Executes a PowerShell script", "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunShellScript", "osType": "Linux", "label": "Executes a Linux shell script", "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ifconfig", "osType": "Linux", "label": "List network configuration", "description": "Get the configuration of all network interfaces." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableAdminAccount", "osType": "Windows", "label": "Enable administrator account", "description": "Checks if the local Administrator account is disabled, and if so enables it." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetAccountPassword", "osType": "Windows", "label": "Reset built-in Administrator account password", "description": "Reset built-in Administrator account password." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RDPSettings", "osType": "Windows", "label": "Verify RDP Listener Settings", "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "SetRDPPort", "osType": "Windows", "label": "Set Remote Desktop port", "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetRDPCert", "osType": "Windows", "label": "Restore RDP Authentication mode to defaults", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index 6445e9d30625..0e150b7de7f7 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -264,6 +264,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.json" + } } } }, @@ -7713,6 +7718,10 @@ "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." } }, "description": "Describes the properties of a Virtual Machine Scale Set." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json index bcf40066ac4b..217c0f707840 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json @@ -1,40 +1,79 @@ { "parameters": { "subscriptionId": "{subscriptionId}", - "api-version": "2018-06-01" + "api-version": "2018-06-01", + "$expand": "virtualMachines\\$ref" }, "responses": { "200": { "body": { "value": [ { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", "properties": { "platformUpdateDomainCount": 5, - "platformFaultDomainCount": 2 + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "centralus", - "tags": { - "{tagName}": "{tagValue}" + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", "sku": { - "name": "Aligned" + "name": "Classic" } }, { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, "properties": { - "platformUpdateDomainCount": 3, - "platformFaultDomainCount": 2 + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "westus", + "location": "westcentralus", "tags": { "{tagName}": "{tagValue}" }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, "sku": { "name": "Classic" } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json index 033cce1df40b..965cf747fc33 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json @@ -19,12 +19,12 @@ { "name": "arg1", "type": "string", - "value": "value1" + "defaultValue": "value1" }, { "name": "arg2", "type": "string", - "value": "value2" + "defaultValue": "value2" } ], "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json index ff6bebf28b12..d6f72c39c771 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json @@ -9,70 +9,70 @@ "body": { "value": [ { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableRemotePS", "osType": "Windows", "label": "Enable remote PowerShell", "description": "Configure the machine to enable remote PowerShell." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "IPConfig", "osType": "Windows", "label": "List IP configuration", "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunPowerShellScript", "osType": "Windows", "label": "Executes a PowerShell script", "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunShellScript", "osType": "Linux", "label": "Executes a Linux shell script", "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ifconfig", "osType": "Linux", "label": "List network configuration", "description": "Get the configuration of all network interfaces." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableAdminAccount", "osType": "Windows", "label": "Enable administrator account", "description": "Checks if the local Administrator account is disabled, and if so enables it." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetAccountPassword", "osType": "Windows", "label": "Reset built-in Administrator account password", "description": "Reset built-in Administrator account password." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RDPSettings", "osType": "Windows", "label": "Verify RDP Listener Settings", "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "SetRDPPort", "osType": "Windows", "label": "Set Remote Desktop port", "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetRDPCert", "osType": "Windows", "label": "Restore RDP Authentication mode to defaults", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 42e44cbd2823..f793a723d513 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -264,6 +264,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.json" + } } } }, @@ -2599,6 +2604,9 @@ }, "Create a scale set with ephemeral os disks.": { "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/CreateAScaleSetWithAutomaticRepairs.json" } } }, @@ -6071,6 +6079,19 @@ }, "description": "Specifies the operating system settings for the virtual machine." }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, "NetworkInterfaceReferenceProperties": { "properties": { "primary": { @@ -7673,6 +7694,10 @@ "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", "description": "The virtual machine profile." @@ -7721,6 +7746,10 @@ "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", "description": "The virtual machine profile." @@ -7729,9 +7758,17 @@ "type": "boolean", "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." } }, "description": "Describes the properties of a Virtual Machine Scale Set." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/CreateAScaleSetWithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/CreateAScaleSetWithAutomaticRepairs.json new file mode 100644 index 000000000000..8e8160513e48 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/CreateAScaleSetWithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-10-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json index b5cc831927b5..bd9cb9e4e140 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json @@ -1,40 +1,79 @@ { "parameters": { "subscriptionId": "{subscriptionId}", - "api-version": "2018-10-01" + "api-version": "2018-10-01", + "$expand": "virtualMachines\\$ref" }, "responses": { "200": { "body": { "value": [ { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", "properties": { "platformUpdateDomainCount": 5, - "platformFaultDomainCount": 2 + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "centralus", - "tags": { - "{tagName}": "{tagValue}" + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", "sku": { - "name": "Aligned" + "name": "Classic" } }, { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, "properties": { - "platformUpdateDomainCount": 3, - "platformFaultDomainCount": 2 + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "westus", + "location": "westcentralus", "tags": { "{tagName}": "{tagValue}" }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, "sku": { "name": "Classic" } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandGet.json index b15195ff297d..ec10bdcb35ff 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandGet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandGet.json @@ -19,12 +19,12 @@ { "name": "arg1", "type": "string", - "value": "value1" + "defaultValue": "value1" }, { "name": "arg2", "type": "string", - "value": "value2" + "defaultValue": "value2" } ], "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandList.json index 6b20efeac977..316ad384a014 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandList.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommandList.json @@ -9,70 +9,70 @@ "body": { "value": [ { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableRemotePS", "osType": "Windows", "label": "Enable remote PowerShell", "description": "Configure the machine to enable remote PowerShell." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "IPConfig", "osType": "Windows", "label": "List IP configuration", "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunPowerShellScript", "osType": "Windows", "label": "Executes a PowerShell script", "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunShellScript", "osType": "Linux", "label": "Executes a Linux shell script", "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ifconfig", "osType": "Linux", "label": "List network configuration", "description": "Get the configuration of all network interfaces." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableAdminAccount", "osType": "Windows", "label": "Enable administrator account", "description": "Checks if the local Administrator account is disabled, and if so enables it." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetAccountPassword", "osType": "Windows", "label": "Reset built-in Administrator account password", "description": "Reset built-in Administrator account password." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RDPSettings", "osType": "Windows", "label": "Verify RDP Listener Settings", "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "SetRDPPort", "osType": "Windows", "label": "Set Remote Desktop port", "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetRDPCert", "osType": "Windows", "label": "Restore RDP Authentication mode to defaults", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 0af319b1f30f..3a626b5f5f45 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -264,6 +264,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.json" + } } } }, @@ -2053,7 +2058,12 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/UpdateImage.json" + } + } }, "delete": { "tags": [ @@ -3136,6 +3146,9 @@ }, "Create a scale set with terminate scheduled events enabled.": { "$ref": "./examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/CreateAScaleSetWithAutomaticRepairs.json" } } }, @@ -6544,7 +6557,7 @@ }, "StorageAccountType": { "type": "string", - "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types ", "enum": [ "Standard_LRS", "Premium_LRS", @@ -6942,10 +6955,27 @@ "allowExtensionOperations": { "type": "boolean", "description": "Specifies whether extension operations should be allowed on the virtual machine.

This may only be set to False when no extensions are present on the virtual machine." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Specifies whether the guest provision signal is required from the virtual machine." } }, "description": "Specifies the operating system settings for the virtual machine." }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, "NetworkInterfaceReferenceProperties": { "properties": { "primary": { @@ -7003,15 +7033,40 @@ }, "description": "Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15." }, + "priority": { + "type": "string", + "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.", + "enum": [ + "Regular", + "Low", + "Spot" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for the Azure Spot VM/VMSS", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + }, "BillingProfile": { "properties": { "maxPrice": { "type": "number", "format": "double", - "description": "Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars.

This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price.

The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: $0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01." + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01." } }, - "description": "Specifies the billing related details of a low priority VM or VMSS.

Minimum api-version: 2019-03-01." + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

Minimum api-version: 2019-03-01." }, "VirtualMachineExtensionHandlerInstanceView": { "properties": { @@ -7306,32 +7361,16 @@ "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

Minimum api-version: 2018-04-01." }, "priority": { - "type": "string", - "description": "Specifies the priority for the virtual machine.

Minimum api-version: 2019-03-01", - "enum": [ - "Regular", - "Low" - ], - "x-ms-enum": { - "name": "VirtualMachinePriorityTypes", - "modelAsString": true - } + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machine.

Minimum api-version: 2019-03-01" }, "evictionPolicy": { - "type": "string", - "description": "Specifies the eviction policy for the low priority virtual machine. Only supported value is 'Deallocate'.

Minimum api-version: 2019-03-01", - "enum": [ - "Deallocate", - "Delete" - ], - "x-ms-enum": { - "name": "VirtualMachineEvictionPolicyTypes", - "modelAsString": true - } + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine. Only supported value is 'Deallocate'.

Minimum api-version: 2019-03-01" }, "billingProfile": { "$ref": "#/definitions/BillingProfile", - "description": "Specifies the billing related details of a low priority virtual machine.

Minimum api-version: 2019-03-01." + "description": "Specifies the billing related details of a Azure Spot virtual machine.

Minimum api-version: 2019-03-01." }, "host": { "$ref": "#/definitions/SubResource", @@ -7563,7 +7602,17 @@ ], "x-ms-enum": { "name": "OperatingSystemTypes", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "Windows", + "description": "Windows OS Type" + }, + { + "value": "Linux", + "description": "Linux OS Type" + } + ] } }, "osState": { @@ -7575,7 +7624,17 @@ ], "x-ms-enum": { "name": "OperatingSystemStateTypes", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "Generalized", + "description": "Generalized image. Needs to be provisioned during deployment time." + }, + { + "value": "Specialized", + "description": "Specialized image. Contains already provisioned OS Disk." + } + ] } }, "snapshot": { @@ -8435,6 +8494,10 @@ }, "VirtualMachineScaleSetUpdateNetworkProfile": { "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, "networkInterfaceConfigurations": { "type": "array", "items": { @@ -8566,32 +8629,16 @@ "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

Possible values are:

Windows_Client

Windows_Server

If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Minimum api-version: 2015-06-15" }, "priority": { - "type": "string", - "description": "Specifies the priority for the virtual machines in the scale set.

Minimum api-version: 2017-10-30-preview", - "enum": [ - "Regular", - "Low" - ], - "x-ms-enum": { - "name": "VirtualMachinePriorityTypes", - "modelAsString": true - } + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set.

Minimum api-version: 2017-10-30-preview" }, "evictionPolicy": { - "type": "string", - "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

Minimum api-version: 2017-10-30-preview", - "enum": [ - "Deallocate", - "Delete" - ], - "x-ms-enum": { - "name": "VirtualMachineEvictionPolicyTypes", - "modelAsString": true - } + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for virtual machines in a Azure Spot scale set.

Minimum api-version: 2017-10-30-preview" }, "billingProfile": { "$ref": "#/definitions/BillingProfile", - "description": "Specifies the billing related details of a low priority VMSS.

Minimum api-version: 2019-03-01." + "description": "Specifies the billing related details of a Azure Spot VMSS.

Minimum api-version: 2019-03-01." }, "scheduledEventsProfile": { "$ref": "#/definitions/ScheduledEventsProfile", @@ -8643,6 +8690,10 @@ "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", "description": "The virtual machine profile." @@ -8699,6 +8750,10 @@ "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", "description": "The virtual machine profile." @@ -8707,6 +8762,10 @@ "type": "boolean", "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." @@ -8718,6 +8777,10 @@ "scaleInPolicy": { "$ref": "#/definitions/ScaleInPolicy", "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." } }, "description": "Describes the properties of a Virtual Machine Scale Set." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAScaleSetWithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAScaleSetWithAutomaticRepairs.json new file mode 100644 index 000000000000..68aa07a0ea3b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAScaleSetWithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-03-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromABlob.json index 055debd6eca4..0b50b88fec63 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromABlob.json @@ -12,7 +12,8 @@ "osType": "Linux", "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", "osState": "Generalized" - } + }, + "zoneResilient": true } } } @@ -28,7 +29,8 @@ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": true }, "provisioningState": "Creating" }, @@ -48,7 +50,8 @@ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": true }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAManagedDisk.json index edd1a07ae4d8..e6c97d0e3994 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAManagedDisk.json @@ -14,7 +14,8 @@ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" }, "osState": "Generalized" - } + }, + "zoneResilient": true } } } @@ -32,7 +33,8 @@ "osState": "Generalized", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": true }, "provisioningState": "Creating" }, @@ -54,7 +56,8 @@ "osState": "Generalized", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": true }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromASnapshot.json index 459f8b7bd7b2..d3d0d827e5b5 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromASnapshot.json @@ -14,7 +14,8 @@ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" }, "osState": "Generalized" - } + }, + "zoneResilient": false } } } @@ -32,7 +33,8 @@ "osState": "Generalized", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": false }, "provisioningState": "Creating" }, @@ -54,7 +56,8 @@ "osState": "Generalized", "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": false }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAVM.json index 92af3a9511f7..1a7b0dccc0b6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAVM.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageFromAVM.json @@ -29,7 +29,8 @@ }, "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": false }, "provisioningState": "Creating" }, @@ -54,7 +55,8 @@ }, "caching": "ReadWrite" }, - "dataDisks": [] + "dataDisks": [], + "zoneResilient": false }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json index 5b4cb0efae6d..353e494809c7 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -18,7 +18,8 @@ "lun": 1, "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" } - ] + ], + "zoneResilient": false } } } @@ -39,7 +40,8 @@ "lun": 1, "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" } - ] + ], + "zoneResilient": false }, "provisioningState": "Creating" }, @@ -64,7 +66,8 @@ "lun": 1, "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" } - ] + ], + "zoneResilient": false }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json index 8260512674b4..a9d6a635ce80 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -22,7 +22,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" } } - ] + ], + "zoneResilient": false } } } @@ -47,7 +48,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" } } - ] + ], + "zoneResilient": false }, "provisioningState": "Creating" }, @@ -76,7 +78,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" } } - ] + ], + "zoneResilient": false }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json index d9e8bce3fc5a..1a39b0d86caf 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -22,7 +22,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" } } - ] + ], + "zoneResilient": true } } } @@ -47,7 +48,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" } } - ] + ], + "zoneResilient": true }, "provisioningState": "Creating" }, @@ -76,7 +78,8 @@ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" } } - ] + ], + "zoneResilient": true }, "provisioningState": "Creating" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetInformationAboutAnImage.json index 14322734b054..2ce1651a8a1d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetInformationAboutAnImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetInformationAboutAnImage.json @@ -39,7 +39,8 @@ }, "storageAccountType": "Standard_LRS" } - ] + ], + "zoneResilient": true }, "provisioningState": "created" } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json index f83d4692138d..d7c2558571ef 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json @@ -1,40 +1,79 @@ { "parameters": { "subscriptionId": "{subscriptionId}", - "api-version": "2019-03-01" + "api-version": "2019-03-01", + "$expand": "virtualMachines\\$ref" }, "responses": { "200": { "body": { "value": [ { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", "properties": { "platformUpdateDomainCount": 5, - "platformFaultDomainCount": 2 + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "centralus", - "tags": { - "{tagName}": "{tagValue}" + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", "sku": { - "name": "Aligned" + "name": "Classic" } }, { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, "properties": { - "platformUpdateDomainCount": 3, - "platformFaultDomainCount": 2 + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "type": "Microsoft.Compute/availabilitySets", - "location": "westus", + "location": "westcentralus", "tags": { "{tagName}": "{tagValue}" }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", - "name": "{availabilitySetName}", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, "sku": { "name": "Classic" } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateImage.json new file mode 100644 index 000000000000..4b09489a0bf1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateImage.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-03-01", + "imageName": "myImage", + "parameters": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "hyperVGeneration": "V1" + }, + "tags": { + "department": "HR" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } + } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandGet.json index 2ee8c2c1f551..79c85f111f2f 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandGet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandGet.json @@ -19,12 +19,12 @@ { "name": "arg1", "type": "string", - "value": "value1" + "defaultValue": "value1" }, { "name": "arg2", "type": "string", - "value": "value2" + "defaultValue": "value2" } ], "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandList.json index ca6d8a7a5247..07c17bc67543 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandList.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/VirtualMachineRunCommandList.json @@ -9,70 +9,70 @@ "body": { "value": [ { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableRemotePS", "osType": "Windows", "label": "Enable remote PowerShell", "description": "Configure the machine to enable remote PowerShell." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "IPConfig", "osType": "Windows", "label": "List IP configuration", "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunPowerShellScript", "osType": "Windows", "label": "Executes a PowerShell script", "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RunShellScript", "osType": "Linux", "label": "Executes a Linux shell script", "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ifconfig", "osType": "Linux", "label": "List network configuration", "description": "Get the configuration of all network interfaces." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "EnableAdminAccount", "osType": "Windows", "label": "Enable administrator account", "description": "Checks if the local Administrator account is disabled, and if so enables it." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetAccountPassword", "osType": "Windows", "label": "Reset built-in Administrator account password", "description": "Reset built-in Administrator account password." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "RDPSettings", "osType": "Windows", "label": "Verify RDP Listener Settings", "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "SetRDPPort", "osType": "Windows", "label": "Set Remote Desktop port", "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." }, { - "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", "id": "ResetRDPCert", "osType": "Windows", "label": "Restore RDP Authentication mode to defaults", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/examples/ListAvailableResourceSkusForARegion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/examples/ListAvailableResourceSkusForARegion.json new file mode 100644 index 000000000000..1b040438586a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/examples/ListAvailableResourceSkusForARegion.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-04-01", + "$filter": "location eq 'westus'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "virtualMachines", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "MaxDataDiskCount", + "value": "1" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "50" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ01" + ], + "zoneDetails": [ + { + "name": [ + "westus-AZ01" + ], + "capabilities": [ + { + "name": "UltraSSDAvailable", + "value": "True" + } + ] + } + ] + } + ], + "name": "Standard_A0", + "tier": "Standard", + "size": "A0", + "family": "standardA0_A7Family" + }, + { + "resourceType": "virtualMachines", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "71680" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "1.75" + }, + { + "name": "MaxDataDiskCount", + "value": "2" + }, + { + "name": "LowPriorityCapable", + "value": "True" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ02", + "westus-AZ01" + ] + } + ], + "name": "Standard_A1", + "tier": "Standard", + "size": "A1", + "family": "standardA0_A7Family" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json index 7012927a8fd3..e579007e9eaa 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json @@ -48,6 +48,13 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." } ], "responses": { @@ -64,6 +71,9 @@ "x-ms-examples": { "Lists all available Resource SKUs": { "$ref": "./examples/ListAvailableResourceSkus.json" + }, + "Lists all available Resource SKUs for the specified region": { + "$ref": "./examples/ListAvailableResourceSkusForARegion.json" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json new file mode 100644 index 000000000000..eeb80123a696 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -0,0 +1,10432 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2019-07-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": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { + "put": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_CreateOrUpdate", + "description": "Create or update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "Parameters supplied to the Create Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/CreateOrUpdateAProximityPlacementGroup.json" + } + } + }, + "patch": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Update", + "description": "Update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupUpdate" + }, + "description": "Parameters supplied to the Update Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/PatchAProximityPlacementGroup.json" + } + } + }, + "delete": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Delete", + "description": "Delete a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/DeleteAProximityPlacementGroup.json" + } + } + }, + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Get", + "description": "Retrieves information about a proximity placement group .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "includeColocationStatus", + "in": "query", + "required": false, + "type": "string", + "description": "includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/GetAProximityPlacementGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInASubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListByResourceGroup", + "description": "Lists all proximity placement groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInAResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/GetADedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/CreateOrUpdateADedicatedHost.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update an dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/GetADedicatedHost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineImageResource" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListByLocation", + "description": "Gets all the virtual machines under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which virtual machines under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/ListVirtualMachinesInASubscriptionByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list)", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + }, + "Create a virtual machine image from a blob with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromABlobWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/UpdateImage.json" + } + } + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/CreateAVmWithADiffOsDisk.json" + }, + "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": { + "$ref": "./examples/CreateAVmWithDiskEncryptionSetResource.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-examples": { + "Get a Virtual Machine.": { + "$ref": "./examples/GetVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + }, + "x-ms-examples": { + "Get Virtual Machine Instance View.": { + "$ref": "./examples/GetVirtualMachineInstanceView.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation.
For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource).
For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Generalize a Virtual Machine.": { + "$ref": "./examples/GeneralizeVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "statusOnly", + "in": "query", + "required": false, + "type": "string", + "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { + "$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reapply", + "description": "The operation to reapply a virtual machine's state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reapply the state of a virtual machine.": { + "$ref": "./examples/ReapplyVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "Shuts down the virtual machine, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" + }, + "Create a scale set with terminate scheduled events enabled.": { + "$ref": "./examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/CreateAScaleSetWithAutomaticRepairs.json" + }, + "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { + "$ref": "./examples/CreateAScalesetWithDiskEncryptionSetResource.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Update", + "description": "The operation to update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate" + }, + "description": "Parameters supplied to the Update VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmScaleSetReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" + }, + "description": "Parameters for Reimaging VM ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", + "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/VMScaleSetExtensionRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", + "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" + }, + "description": "The input object for ConvertToSinglePlacementGroup API." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Update", + "description": "The operation to update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/UpdateVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Delete", + "description": "The operation to delete the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/DeleteVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Get", + "description": "The operation to get the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/GetVirtualMachineScaleSetVMExtensions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_List", + "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List extensions in Vmss instance.": { + "$ref": "./examples/ListVirtualMachineScaleSetVMExtensions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/LogAnalyticsThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + }, + "SubResourceWithColocationStatus": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of a resource in the Proximity Placement Group." + } + } + }, + "ProximityPlacementGroupProperties": { + "properties": { + "proximityPlacementGroupType": { + "type": "string", + "description": "Specifies the type of the proximity placement group.

Possible values are:

**Standard** : Co-locate resources within an Azure region or Availability Zone.

**Ultra** : For future use.", + "enum": [ + "Standard", + "Ultra" + ], + "x-ms-enum": { + "name": "ProximityPlacementGroupType", + "modelAsString": true + } + }, + "virtualMachines": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machine scale sets in the proximity placement group." + }, + "availabilitySets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all availability sets in the proximity placement group." + }, + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of the Proximity Placement Group." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "ProximityPlacementGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProximityPlacementGroupProperties", + "description": "Describes the properties of a Proximity Placement Group." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "The list of proximity placement groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of proximity placement groups." + } + }, + "required": [ + "value" + ], + "description": "The List Proximity Placement Group operation response." + }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 3, + "description": "Number of fault domains that the host group can span." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "double", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 2, + "description": "Fault domain of the dedicated host within a dedicated host group." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform.

Does not change throughout the lifetime of the host." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date when the host was first provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The list dedicated host operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "AutomaticOSUpgradeProperties": { + "properties": { + "automaticOSUpgradeSupported": { + "type": "boolean", + "description": "Specifies whether automatic OS upgrade is supported on the image." + } + }, + "required": [ + "automaticOSUpgradeSupported" + ], + "description": "Describes automatic OS upgrade properties on the image." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType" + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

[List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "DiskEncryptionSetParameters": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true + } + }, + "DiffDiskSettings": { + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "diskIOPSReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "diskMBpsReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "AdditionalCapabilities": { + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of WinRM listener.

Possible values are:
**http**

**https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".

Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    **Note: Do not pass any secrets or passwords in customData property**

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "priority": { + "type": "string", + "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.", + "enum": [ + "Regular", + "Low", + "Spot" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for the Azure Spot VM/VMSS", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + }, + "BillingProfile": { + "properties": { + "maxPrice": { + "type": "number", + "format": "double", + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "readOnly": true, + "type": "string", + "description": "The console screenshot blob URI." + }, + "serialConsoleLogBlobUri": { + "readOnly": true, + "type": "string", + "description": "The Linux serial console log blob Uri." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The boot diagnostics status information for the VM.

    NOTE: It will be set only if there are errors encountered in enabling boot diagnostics." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "Specifies the HyperVGeneration Type associated with a resource", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationType", + "modelAsString": true + } + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set.

    This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + }, + "virtualMachineScaleSet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.

    This property cannot exist along with a non-null properties.availabilitySet reference.

    Minimum api‐version: 2019‐03‐01" + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "priority": { + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01" + }, + "evictionPolicy": { + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01." + }, + "host": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku." + }, + "AutomaticOSUpgradePolicy": { + "properties": { + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + }, + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ScaleInPolicy": { + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetScaleInRules", + "modelAsString": true + } + }, + "description": "The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    " + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false, + "values": [ + { + "value": "Generalized", + "description": "Generalized image. Needs to be provisioned during deployment time." + }, + { + "value": "Specialized", + "description": "Specialized image. Contains already provisioned OS Disk." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageDisk": { + "properties": { + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + } + }, + "description": "Describes a image disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType", + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image" + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

    **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "priority": { + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview" + }, + "evictionPolicy": { + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "RollbackStatusInfo": { + "properties": { + "successfullyRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VMs in each state." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", + "description": "Specifies the network profile configuration of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "modelDefinitionApplied": { + "readOnly": true, + "type": "string", + "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." + }, + "protectionPolicy": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", + "description": "Specifies the protection policy of the virtual machine." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "properties": { + "protectFromScaleIn": { + "type": "boolean", + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "type": "boolean", + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + }, + "VMScaleSetConvertToSinglePlacementGroupInput": { + "properties": { + "activePlacementGroupId": { + "type": "string", + "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/disk.json new file mode 100644 index 000000000000..508b04311d46 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/disk.json @@ -0,0 +1,1952 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2019-07-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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}": { + "put": { + "tags": [ + "Disks" + ], + "operationId": "Disks_CreateOrUpdate", + "description": "Creates or updates a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Disk" + }, + "description": "Disk object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Create an empty managed disk.": { + "$ref": "./examples/CreateAnEmptyManagedDisk.json" + }, + "Create a managed disk from a platform image.": { + "$ref": "./examples/CreateAManagedDiskFromAPlatformImage.json" + }, + "Create a managed disk from an existing managed disk in the same or different subscription.": { + "$ref": "./examples/CreateAManagedDiskFromAnExistingManagedDisk.json" + }, + "Create a managed disk by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a managed disk by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json" + }, + "Create a managed disk by copying a snapshot.": { + "$ref": "./examples/CreateAManagedDiskByCopyingASnapshot.json" + }, + "Create a managed upload disk.": { + "$ref": "./examples/CreateAManagedUploadDisk.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Update", + "description": "Updates (patches) a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskUpdate" + }, + "description": "Disk object supplied in the body of the Patch disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Get", + "description": "Gets information about a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Get information about a managed disk.": { + "$ref": "./examples/GetInformationAboutAManagedDisk.json" + } + } + }, + "delete": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Delete", + "description": "Deletes a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk is deleted, this is an expected error code." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_ListByResourceGroup", + "description": "Lists all the disks under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a resource group.": { + "$ref": "./examples/ListManagedDisksInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_List", + "description": "Lists all the disks under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a subscription.": { + "$ref": "./examples/ListManagedDisksInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_GrantAccess", + "description": "Grants access to a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_RevokeAccess", + "description": "Revokes access to a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "description": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Create a snapshot from an existing snapshot in the same or a different subscription.": { + "$ref": "./examples/CreateASnapshotFromAnExistingSnapshot.json" + }, + "Create a snapshot by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a snapshot by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "description": "Updates (patches) a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotUpdate" + }, + "description": "Snapshot object supplied in the body of the Patch snapshot operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "description": "Gets information about a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Get information about a snapshot.": { + "$ref": "./examples/GetInformationAboutASnapshot.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "description": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the snapshot is deleted, this is an expected error code." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "description": "Lists snapshots under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a resource group.": { + "$ref": "./examples/ListSnapshotsInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "description": "Lists snapshots under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a subscription.": { + "$ref": "./examples/ListSnapshotsInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_GrantAccess", + "description": "Grants access to a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get snapshot access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RevokeAccess", + "description": "Revokes access to a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}": { + "put": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_CreateOrUpdate", + "description": "Creates or updates a disk encryption set", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "disk encryption set object supplied in the body of the Put disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk encryption set.": { + "$ref": "./examples/CreateADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Update", + "description": "Updates (patches) a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSetUpdate" + }, + "description": "disk encryption set object supplied in the body of the Patch disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk encryption set.": { + "$ref": "./examples/UpdateADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Get", + "description": "Gets information about a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk encryption set.": { + "$ref": "./examples/GetInformationAboutADiskEncryptionSet.json" + } + } + }, + "delete": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Delete", + "description": "Deletes a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk encryption set is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk encryption set.": { + "$ref": "./examples/DeleteADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListByResourceGroup", + "description": "Lists all the disk encryption sets under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a resource group.": { + "$ref": "./examples/ListDiskEncryptionSetsInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_List", + "description": "Lists all the disk encryption sets under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a subscription.": { + "$ref": "./examples/ListDiskEncryptionSetsInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "Disk": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + }, + "sku": { + "$ref": "#/definitions/DiskSku" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Logical zone list for Disk." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Disk resource." + }, + "DiskUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/DiskSku" + } + }, + "description": "Disk update resource." + }, + "DiskList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "description": "A list of disks." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks." + } + }, + "required": [ + "value" + ], + "description": "The List Disks operation response." + }, + "DiskSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ], + "x-ms-enum": { + "name": "DiskStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "UltraSSD_LRS", + "description": "Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads." + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "SnapshotSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ], + "x-ms-enum": { + "name": "SnapshotStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage" + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage" + }, + { + "value": "Standard_ZRS", + "description": "Standard zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "DiskProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int32", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskState": { + "type": "string", + "description": "The state of the disk.", + "readOnly": true, + "enum": [ + "Unattached", + "Attached", + "Reserved", + "ActiveSAS", + "ReadyToUpload", + "ActiveUpload" + ], + "x-ms-enum": { + "name": "DiskState", + "modelAsString": true, + "values": [ + { + "value": "Unattached", + "description": "The disk is not being used and can be attached to a VM." + }, + { + "value": "Attached", + "description": "The disk is currently mounted to a running VM." + }, + { + "value": "Reserved", + "description": "The disk is mounted to a stopped-deallocated VM" + }, + { + "value": "ActiveSAS", + "description": "The disk currently has an Active SAS Uri associated with it." + }, + { + "value": "ReadyToUpload", + "description": "A disk is ready to be created by upload by requesting a write token." + }, + { + "value": "ActiveUpload", + "description": "A disk is created for upload and a write token has been issued for uploading to it." + } + ] + } + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "SnapshotProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "incremental": { + "type": "boolean", + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "EncryptionSetProperties": { + "properties": { + "activeKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "The key vault key which is currently used by this disk encryption set." + }, + "previousKeys": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + "description": "A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk encryption set provisioning state." + } + } + }, + "EncryptionSettingsCollection": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + }, + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndSecretReference", + "description": "Key Vault Secret Url and vault id of the disk encryption key" + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key." + } + }, + "description": "Encryption settings for one disk volume." + }, + "KeyVaultAndSecretReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "KeyVaultAndKeyReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "SourceVault": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "Encryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk is encrypted with XStore managed key at rest. It is the default encryption type." + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk is encrypted with Customer managed key at rest." + } + ] + } + } + }, + "required": [ + "type" + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "DiskUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int32", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + } + }, + "description": "Disk resource update properties." + }, + "SnapshotUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + } + }, + "description": "Snapshot resource update properties." + }, + "DiskEncryptionSetUpdateProperties": { + "properties": { + "activeKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference" + } + }, + "description": "disk encryption set resource update properties." + }, + "CreationData": { + "properties": { + "createOption": { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ], + "x-ms-enum": { + "name": "DiskCreateOption", + "modelAsString": true, + "values": [ + { + "value": "Empty", + "description": "Create an empty data disk of a size given by diskSizeGB." + }, + { + "value": "Attach", + "description": "Disk will be attached to a VM." + }, + { + "value": "FromImage", + "description": "Create a new disk from a platform image specified by the given imageReference." + }, + { + "value": "Import", + "description": "Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId." + }, + { + "value": "Copy", + "description": "Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId." + }, + { + "value": "Restore", + "description": "Create a new disk by copying from a backup recovery point." + }, + { + "value": "Upload", + "description": "Create a new disk by obtaining a write token and using it to directly upload the contents of the disk." + } + ] + }, + "description": "This enumerates the possible sources of a disk's creation." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "imageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Disk source information." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUniqueId": { + "readOnly": true, + "type": "string", + "description": "If this field is set, this is the unique id identifying the source of this resource." + }, + "uploadSizeBytes": { + "type": "integer", + "format": "int64", + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "ImageDiskReference": { + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "GrantAccessData": { + "properties": { + "access": { + "type": "string", + "enum": [ + "None", + "Read", + "Write" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "durationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time duration in seconds until the SAS access expires." + } + }, + "required": [ + "access", + "durationInSeconds" + ], + "description": "Data used for requesting a SAS." + }, + "AccessUri": { + "properties": { + "accessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a disk." + } + }, + "description": "A disk access SAS uri." + }, + "Snapshot": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "Unused. Always Null." + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Snapshot resource." + }, + "SnapshotUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + } + }, + "description": "Snapshot update resource." + }, + "SnapshotList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "A list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "required": [ + "value" + ], + "description": "The List Snapshots operation response." + }, + "EncryptionSetIdentity": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetIdentityType", + "modelAsString": true + }, + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "DiskEncryptionSet": { + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EncryptionSetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "disk encryption set resource." + }, + "DiskEncryptionSetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskEncryptionSetUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "disk encryption set update resource." + }, + "DiskEncryptionSetList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "A list of disk encryption sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets." + } + }, + "required": [ + "value" + ], + "description": "The List disk encryption set operation response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "DiskNameParameter": { + "name": "diskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "SnapshotNameParameter": { + "name": "snapshotName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "DiskEncryptionSetNameParameter": { + "name": "diskEncryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..46c90a6dacec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "caching": "ReadWrite", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..0cfc745615f9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateADiskEncryptionSet.json new file mode 100644 index 000000000000..cf0f403d3086 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateADiskEncryptionSet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByCopyingASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByCopyingASnapshot.json new file mode 100644 index 000000000000..a8c9f5ff9adf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByCopyingASnapshot.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..b44f596c8fb6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..58a6d7af3c92 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAPlatformImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAPlatformImage.json new file mode 100644 index 000000000000..b2e22fa5975e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAPlatformImage.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json new file mode 100644 index 000000000000..9ca47d0a1429 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk2", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedUploadDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedUploadDisk.json new file mode 100644 index 000000000000..998666f7ed65 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAManagedUploadDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..220b0bdf6695 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..7d0338300cee --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetFromACustomImage.json new file mode 100644 index 000000000000..25e6989304f6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetFromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..98a86b68924a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json new file mode 100644 index 000000000000..788cb0980fd4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json new file mode 100644 index 000000000000..0bbb9bfc658f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "publicIPAddressConfiguration": { + "name": "{vmss-name}", + "properties": { + "publicIPAddressVersion": "IPv4" + } + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAutomaticRepairs.json new file mode 100644 index 000000000000..6791548f32e7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithBootDiagnostics.json new file mode 100644 index 000000000000..ff3381b48947 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithDiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithDiffOsDisk.json new file mode 100644 index 000000000000..18304f85e883 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithDiffOsDisk.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..a5dc69acfe5a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Succeeded" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPasswordAuthentication.json new file mode 100644 index 000000000000..209950e4b1b3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPremiumStorage.json new file mode 100644 index 000000000000..0d43febd86fe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithSshAuthentication.json new file mode 100644 index 000000000000..b8912565a8ab --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json new file mode 100644 index 000000000000..b2afe164e36b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithVMsInDifferentZones.json new file mode 100644 index 000000000000..6bd73fbae2f0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScaleSetWithVMsInDifferentZones.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "location": "centralus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + } + }, + "zones": [ + "1", + "3" + ] + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Succeeded" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Creating" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..c1461518d4d5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..201cdd1711d6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..a58c83032c32 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotFromAnExistingSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotFromAnExistingSnapshot.json new file mode 100644 index 000000000000..33a1e75795bc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateASnapshotFromAnExistingSnapshot.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmFromACustomImage.json new file mode 100644 index 000000000000..dd4aeadff6d9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmFromACustomImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmInAnAvailabilitySet.json new file mode 100644 index 000000000000..6bca5a058837 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmInAnAvailabilitySet.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithADiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithADiffOsDisk.json new file mode 100644 index 000000000000..2303001c813d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithADiffOsDisk.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..26c4a9d6680a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithBootDiagnostics.json new file mode 100644 index 000000000000..325fddd66658 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithBootDiagnostics.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..acd36925567b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithDiskEncryptionSetResource.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskencryptionset-name}" + } + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithEmptyDataDisks.json new file mode 100644 index 000000000000..46bfda2b77af --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithEmptyDataDisks.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": false + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPasswordAuthentication.json new file mode 100644 index 000000000000..cdc2fb319f3b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPasswordAuthentication.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPremiumStorage.json new file mode 100644 index 000000000000..9e56529d4ab8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithPremiumStorage.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithSshAuthentication.json new file mode 100644 index 000000000000..cc5dcc09b2cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAVmWithSshAuthentication.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnAvailabilitySet.json new file mode 100644 index 000000000000..0b034a17a888 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnAvailabilitySet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnEmptyManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnEmptyManagedDisk.json new file mode 100644 index 000000000000..8cffe4653a4c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnEmptyManagedDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlob.json new file mode 100644 index 000000000000..978e18726499 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlob.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json new file mode 100644 index 000000000000..3536694c5a4a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDisk.json new file mode 100644 index 000000000000..1183cb4ae11a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json new file mode 100644 index 000000000000..094a858d799d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshot.json new file mode 100644 index 000000000000..3e028823aef1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json new file mode 100644 index 000000000000..555be69eb392 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAVM.json new file mode 100644 index 000000000000..991c53007d1d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageFromAVM.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json new file mode 100644 index 000000000000..6d1f1192c030 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json new file mode 100644 index 000000000000..1f497628f145 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json new file mode 100644 index 000000000000..bd24d775f6bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHost.json new file mode 100644 index 000000000000..be99526847e4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHost.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + }, + "properties": { + "platformFaultDomain": 1 + }, + "sku": { + "name": "DSv3-Type1" + } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHost", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}" + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHostGroup.json new file mode 100644 index 000000000000..3d4ec8a42903 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateAProximityPlacementGroup.json new file mode 100644 index 000000000000..81e18a1fa387 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateAProximityPlacementGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "location": "westus", + "properties": { + "proximityPlacementGroupType": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + }, + "201": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..9179523838a1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2019-07-01", + "extensionParameters": { + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "200": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteADiskEncryptionSet.json new file mode 100644 index 000000000000..a33b02d8bbc9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteADiskEncryptionSet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskEncryptionSetName": "myDiskEncryptionSet", + "api-version": "2019-07-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteAProximityPlacementGroup.json new file mode 100644 index 000000000000..78c6df17f36c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteAProximityPlacementGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..db6207d8f09a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2019-07-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GeneralizeVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GeneralizeVirtualMachine.json new file mode 100644 index 000000000000..8078bc757ed1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GeneralizeVirtualMachine.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "vmName": "myVMName" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHost.json new file mode 100644 index 000000000000..0da47da294d4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHost.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHostGroup.json new file mode 100644 index 000000000000..f383d65e8771 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetADedicatedHostGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } + ] + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetAProximityPlacementGroup.json new file mode 100644 index 000000000000..6aa8dad877ec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetAProximityPlacementGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutADiskEncryptionSet.json new file mode 100644 index 000000000000..86e3fe86147d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutADiskEncryptionSet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSet", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAManagedDisk.json new file mode 100644 index 000000000000..7b81f6786542 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAManagedDisk.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskName": "myManagedDisk" + }, + "responses": { + "200": { + "body": { + "managedBy": "/subscriptions/123caaa-123v-v211-a49f-f88ccac5bf88/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachines/TestVM414689371c88843d65ec", + "sku": { + "name": "Standard_LRS" + }, + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutASnapshot.json new file mode 100644 index 000000000000..dbfb784cc43d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutASnapshot.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "snapshotName": "mySnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAnImage.json new file mode 100644 index 000000000000..d6ae6aeb4836 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetInformationAboutAnImage.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachine.json new file mode 100644 index 000000000000..ab3de830d2a4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachine.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01" + }, + "hardwareProfile": { + "vmSize": "Standard_DS3_v2" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "myDataDisk0", + "createOption": "Empty", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0" + }, + "diskSizeGB": 30 + }, + { + "lun": 1, + "name": "myDataDisk1", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1" + }, + "diskSizeGB": 100 + } + ] + }, + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{myStorageAccount}.blob.core.windows.net" + } + }, + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "west us", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineInstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineInstanceView.json new file mode 100644 index 000000000000..962dead238a1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineInstanceView.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "vmName": "myVM" + }, + "responses": { + "200": { + "body": { + "platformUpdateDomain": 1, + "platformFaultDomain": 1, + "computerName": "myVM", + "osName": "Windows Server 2016 Datacenter", + "osVersion": "Microsoft Windows NT 10.0.14393.0", + "vmAgent": { + "vmAgentVersion": "2.7.41491.949", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready", + "message": "GuestAgent is running and accepting new configurations.", + "time": "2019-10-14T23:11:22+00:00" + } + ], + "extensionHandlers": [ + { + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "status": { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready" + } + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.477089+00:00" + } + ] + }, + { + "name": "myDataDisk0", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.461517+00:00" + } + ] + } + ], + "bootDiagnostics": { + "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp", + "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log" + }, + "extensions": [ + { + "name": "IaaSAntiMalware-ext0", + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Microsoft Antimalware enabled" + } + ] + } + ], + "hyperVGeneration": "V1", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..19fb1669c966 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/GetVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json new file mode 100644 index 000000000000..719e9496ee1e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2019-07-01", + "$expand": "virtualMachines\\$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailableVmSizes_VirtualMachines.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailableVmSizes_VirtualMachines.json new file mode 100644 index 000000000000..80f61a9e8d94 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailableVmSizes_VirtualMachines.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVmName", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_A1_V2", + "numberOfCores": 1, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 10240, + "memoryInMB": 2048, + "maxDataDiskCount": 2 + }, + { + "name": "Standard_A2_V2", + "numberOfCores": 2, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 20480, + "memoryInMB": 4096, + "maxDataDiskCount": 4 + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInAResourceGroup.json new file mode 100644 index 000000000000..765903ddc404 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInAResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSet", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSet", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSet?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInASubscription.json new file mode 100644 index 000000000000..fa863421fa03 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListDiskEncryptionSetsInASubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSet", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSet", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSet?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInAResourceGroup.json new file mode 100644 index 000000000000..1177e32ca71e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInAResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInASubscription.json new file mode 100644 index 000000000000..ed9d8d03c436 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListImagesInASubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInAResourceGroup.json new file mode 100644 index 000000000000..84c83692e04e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInAResourceGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInASubscription.json new file mode 100644 index 000000000000..49e05b8e5583 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListManagedDisksInASubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInAResourceGroup.json new file mode 100644 index 000000000000..af32461360c5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInAResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInASubscription.json new file mode 100644 index 000000000000..dc6802811c0e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListProximityPlacementGroupsInASubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-07-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInAResourceGroup.json new file mode 100644 index 000000000000..843b2fe788d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInAResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInASubscription.json new file mode 100644 index 000000000000..e833eabfade5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListSnapshotsInASubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.6630569+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "name": "mySnapshot1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.3247198+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..397a96e2ecaa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + }, + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher1", + "type": "extType1", + "typeHandlerVersion": "1.0", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension1", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachinesInASubscriptionByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachinesInASubscriptionByLocation.json new file mode 100644 index 000000000000..c06c0d7f91d1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListVirtualMachinesInASubscriptionByLocation.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "location": "eastus", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + }, + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsRequestRateByInterval.json new file mode 100644 index 000000000000..cfcd632dcc54 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsRequestRateByInterval.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2019-07-01", + "parameters": { + "intervalLength": "FiveMins", + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByResourceName": true + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" + } + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsThrottledRequests.json new file mode 100644 index 000000000000..279212f47003 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/LogAnalyticsThrottledRequests.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2019-07-01", + "parameters": { + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByOperationName": true, + "groupByResourceName": false + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" + } + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/PatchAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/PatchAProximityPlacementGroup.json new file mode 100644 index 000000000000..68d010c06e70 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/PatchAProximityPlacementGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "tags": { + "additionalProp1": "string" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReapplyVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReapplyVirtualMachine.json new file mode 100644 index 000000000000..2f83ad0708cc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReapplyVirtualMachine.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2019-07-01", + "vmName": "VMName" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReimageVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReimageVirtualMachine.json new file mode 100644 index 000000000000..d980861f9fb8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ReimageVirtualMachine.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateADiskEncryptionSet.json new file mode 100644 index 000000000000..e6625fbed7ca --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateADiskEncryptionSet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGallery.json new file mode 100644 index 000000000000..02c4625a01f3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGallery.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "galleryName": "myGalleryName", + "gallery": { + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplication.json new file mode 100644 index 000000000000..ecff95197b2a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplication.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplicationVersion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplicationVersion.json new file mode 100644 index 000000000000..2027cc64296f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryApplicationVersion.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImage.json new file mode 100644 index 000000000000..c24dbc6d8898 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImage.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImageVersion.json new file mode 100644 index 000000000000..7a309fe75cad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateASimpleGalleryImageVersion.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateImage.json new file mode 100644 index 000000000000..f26d12155db6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateImage.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-07-01", + "imageName": "myImage", + "parameters": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "hyperVGeneration": "V1" + }, + "tags": { + "department": "HR" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } + } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json new file mode 100644 index 000000000000..22fb3b3d2ac9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2019-07-01", + "parameters": { + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "toBeDetached": true + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "toBeDetached": false + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..50dc47946f3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2019-07-01", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VMScaleSetExtensionRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VMScaleSetExtensionRollingUpgrade.json new file mode 100644 index 000000000000..be4329609574 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VMScaleSetExtensionRollingUpgrade.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2019-07-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..0d23098c8d67 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommand.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": 1, + "api-version": "2019-07-01", + "monitor": "true", + "parameters": { + "commandId": "RunPowerShellScript" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "This is a sample script with parameters value1 value2" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandGet.json new file mode 100644 index 000000000000..1ce41b24b9aa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "script": [ + "param(", + " [string]$arg1,", + " [string]$arg2", + ")", + "Write-Host This is a sample script with parameters $arg1 $arg2" + ], + "parameters": [ + { + "name": "arg1", + "type": "string", + "defaultValue": "value1" + }, + { + "name": "arg2", + "type": "string", + "defaultValue": "value2" + } + ], + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandList.json new file mode 100644 index 000000000000..db5580fda698 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/VirtualMachineRunCommandList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableRemotePS", + "osType": "Windows", + "label": "Enable remote PowerShell", + "description": "Configure the machine to enable remote PowerShell." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "IPConfig", + "osType": "Windows", + "label": "List IP configuration", + "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunShellScript", + "osType": "Linux", + "label": "Executes a Linux shell script", + "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ifconfig", + "osType": "Linux", + "label": "List network configuration", + "description": "Get the configuration of all network interfaces." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableAdminAccount", + "osType": "Windows", + "label": "Enable administrator account", + "description": "Checks if the local Administrator account is disabled, and if so enables it." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetAccountPassword", + "osType": "Windows", + "label": "Reset built-in Administrator account password", + "description": "Reset built-in Administrator account password." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RDPSettings", + "osType": "Windows", + "label": "Verify RDP Listener Settings", + "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "SetRDPPort", + "osType": "Windows", + "label": "Set Remote Desktop port", + "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetRDPCert", + "osType": "Windows", + "label": "Restore RDP Authentication mode to defaults", + "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate." + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json index 9af963b8fced..271186b61e9a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json @@ -101,6 +101,60 @@ } } }, + "patch": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Update", + "description": "Update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryUpdate" + }, + "description": "Parameters supplied to the update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery.": { + "$ref": "./examples/UpdateASimpleGallery.json" + } + } + }, "get": { "tags": [ "Galleries" @@ -268,6 +322,67 @@ } } }, + "patch": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Update", + "description": "Update a gallery Image Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be updated." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Image Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageUpdate" + }, + "description": "Parameters supplied to the update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery image.": { + "$ref": "./examples/UpdateASimpleGalleryImage.json" + } + } + }, "get": { "tags": [ "GalleryImages" @@ -459,6 +574,74 @@ } } }, + "patch": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Update", + "description": "Update a gallery Image Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Image Definition in which the Image Version is to be updated." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Image Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersionUpdate" + }, + "description": "Parameters supplied to the update gallery Image Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple Gallery Image Version (Managed Image as source).": { + "$ref": "./examples/UpdateASimpleGalleryImageVersion.json" + } + } + }, "get": { "tags": [ "GalleryImageVersions" @@ -674,6 +857,67 @@ } } }, + "patch": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Update", + "description": "Update a gallery Application Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be updated." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationUpdate" + }, + "description": "Parameters supplied to the update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application.": { + "$ref": "./examples/UpdateASimpleGalleryApplication.json" + } + } + }, "get": { "tags": [ "GalleryApplications" @@ -862,6 +1106,74 @@ } } }, + "patch": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Update", + "description": "Update a gallery Application Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be updated." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionUpdate" + }, + "description": "Parameters supplied to the update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application Version.": { + "$ref": "./examples/UpdateASimpleGalleryApplicationVersion.json" + } + } + }, "get": { "tags": [ "GalleryApplicationVersions" @@ -1307,6 +1619,20 @@ ], "description": "Specifies information about the Shared Image Gallery that you want to create or update." }, + "GalleryUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to update." + }, "GalleryProperties": { "properties": { "description": { @@ -1357,6 +1683,20 @@ ], "description": "Specifies information about the gallery Application Definition that you want to create or update." }, + "GalleryApplicationUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to update." + }, "GalleryApplicationProperties": { "properties": { "description": { @@ -1412,6 +1752,20 @@ ], "description": "Specifies information about the gallery Application Version that you want to create or update." }, + "GalleryApplicationVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the gallery Application Version that you want to update." + }, "GalleryApplicationVersionProperties": { "properties": { "publishingProfile": { @@ -1496,6 +1850,20 @@ ], "description": "Specifies information about the gallery Image Definition that you want to create or update." }, + "GalleryImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the gallery Image Definition that you want to update." + }, "GalleryImageProperties": { "properties": { "description": { @@ -1680,6 +2048,20 @@ ], "description": "Specifies information about the gallery Image Version that you want to create or update." }, + "GalleryImageVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the gallery Image Version that you want to update." + }, "GalleryImageVersionProperties": { "properties": { "publishingProfile": { @@ -2065,7 +2447,7 @@ "$ref": "#/definitions/ApiError" } }, - "description": "An error response from the Gallery service." + "description": "An error response from the Compute service." }, "ApiError": { "properties": { @@ -2159,6 +2541,34 @@ "location" ], "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true } }, "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/runCommands.json new file mode 100644 index 000000000000..c208cfa0a01e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/runCommands.json @@ -0,0 +1,467 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2019-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/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}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { + "$ref": "./examples/VirtualMachineRunCommandList.json" + } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { + "$ref": "./examples/VirtualMachineRunCommandGet.json" + } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { + "$ref": "./examples/VirtualMachineRunCommand.json" + } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "Run command operation response." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.go.md b/specification/compute/resource-manager/readme.go.md index 2cd48aec7d6a..7c4552f5e38c 100644 --- a/specification/compute/resource-manager/readme.go.md +++ b/specification/compute/resource-manager/readme.go.md @@ -12,7 +12,7 @@ go: ```yaml $(go) && $(multiapi) batch: - - tag: package-2019-07-01 + - tag: package-2019-07 - tag: package-2019-03-01 - tag: package-2018-10-01 - tag: package-2018-06 @@ -29,12 +29,12 @@ batch: - tag: package-container-service-2015-11-preview ``` -### Tag: package-2019-07-01 and go +### Tag: package-2019-07 and go -These settings apply only when `--tag=package-2019-07-01 --go` is specified on the command line. +These settings apply only when `--tag=package-2019-07 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -```yaml $(tag)=='package-2019-07-01' && $(go) +```yaml $(tag)=='package-2019-07' && $(go) namespace: compute output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-07-01/$(namespace) ``` diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 2d93aff01922..814383963dee 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2019-07-01 +tag: package-2019-07 directive: - where: @@ -134,6 +134,10 @@ directive: - $.definitions.DedicatedHostUpdate suppress: - RequiredPropertiesMissingInResourceModel + - where: + - $.definitions.DiskEncryptionSetParameters + suppress: + - RequiredPropertiesMissingInResourceModel - where: - $.definitions.VirtualMachineScaleSetVM @@ -155,10 +159,6 @@ directive: - $.definitions.VirtualMachineImage suppress: - TrackedResourcePatchOperation - - where: - - $.definitions.VirtualMachineImageResource - suppress: - - TrackedResourceGetOperation - where: - $.definitions.Gallery suppress: @@ -172,13 +172,15 @@ directive: suppress: - TrackedResourcePatchOperation + - where: + - $.definitions.VirtualMachineImageResource + suppress: + - TrackedResourceGetOperation - where: - $.definitions.AdditionalCapabilities.properties.ultraSSDEnabled suppress: - DefinitionsPropertiesNamesCamelCase - - - where: - $.definitions.DiskProperties.properties.diskIOPSReadWrite suppress: @@ -187,6 +189,14 @@ directive: - $.definitions.DiskUpdateProperties.properties.diskIOPSReadWrite suppress: - DefinitionsPropertiesNamesCamelCase + - where: + - $.definitions.DataDisk.properties.diskIOPSReadWrite + suppress: + - DefinitionsPropertiesNamesCamelCase + - where: + - $.definitions.VirtualMachineScaleSetDataDisk.properties.diskIOPSReadWrite + suppress: + - DefinitionsPropertiesNamesCamelCase - where: - $.definitions.ContainerService @@ -196,6 +206,20 @@ directive: - ACS service is deprecated so a PATCH endpoint won't be implemented ``` +### Tag: package-2019-07 + +These settings apply only when `--tag=package-2019-07` is specified on the command line. + +``` yaml $(tag) == 'package-2019-07' +input-file: +- Microsoft.Compute/stable/2019-07-01/compute.json +- Microsoft.Compute/stable/2019-07-01/runCommands.json +- Microsoft.Compute/stable/2019-04-01/skus.json +- Microsoft.Compute/stable/2019-07-01/disk.json +- Microsoft.Compute/stable/2019-07-01/gallery.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + ### Tag: package-2019-07-01 These settings apply only when `--tag=package-2019-07-01` is specified on the command line. @@ -205,7 +229,7 @@ input-file: - Microsoft.Compute/stable/2019-03-01/compute.json - Microsoft.Compute/stable/2019-03-01/runCommands.json - Microsoft.Compute/stable/2019-04-01/skus.json -- Microsoft.Compute/stable/2019-03-01/disk.json +- Microsoft.Compute/stable/2019-07-01/disk.json - Microsoft.Compute/stable/2019-07-01/gallery.json - Microsoft.ContainerService/stable/2017-01-31/containerService.json ``` @@ -216,7 +240,10 @@ These settings apply only when `--tag=package-2019-07-01-only` is specified on t ``` yaml $(tag) == 'package-2019-07-01-only' input-file: +- Microsoft.Compute/stable/2019-07-01/compute.json +- Microsoft.Compute/stable/2019-07-01/disk.json - Microsoft.Compute/stable/2019-07-01/gallery.json +- Microsoft.Compute/stable/2019-07-01/runCommands.json ``` ### Tag: package-2019-03-01 @@ -623,7 +650,7 @@ Please also specify `--azure-libraries-for-java-folder=